Skip to content

Commit

Permalink
Note that package is available on MELPA
Browse files Browse the repository at this point in the history
The package is now available on MELPA, so update README to note that
it's as simple as a M-x package-install.

Signed-off-by: Mark Stemm <[email protected]>
  • Loading branch information
mstemm authored and poiana committed Mar 2, 2023
1 parent aca0e1b commit 1ad301d
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,29 @@ A custom checker for Falco rules files that can be loaded using the [Flycheck](h

## Setup

### Prerequsites

First, [install](https://www.flycheck.org/en/latest/user/installation.html) and [enable](https://www.flycheck.org/en/latest/user/quickstart.html) Flycheck if not already installed.

The default configuration for this integration relies on running Falco via [docker](https://falco.org/docs/getting-started/running/#docker).

1. [Install](https://www.flycheck.org/en/latest/user/installation.html) and [enable](https://www.flycheck.org/en/latest/user/quickstart.html) Flycheck if not already installed.
### Installation Using MELPA

This checker is available on [MELPA](https://melpa.org/). Assuming you already have MELPA configured as a package source, it can be installed via:

```
M-x package-install RET flycheck-falco-rules RET
```

And then add the following to your `.emacs` file:

```
(with-eval-after-load 'flycheck
(add-hook 'flycheck-mode-hook #'flycheck-falco-rules-setup))
```

### Manual Installation

1. Copy `flycheck-falco-rules.el` locally (for example, `~/elisp/flycheck-falco-rules.el`)
1. Add the following to your `.emacs` file:

Expand Down

0 comments on commit 1ad301d

Please sign in to comment.