Skip to content

Commit

Permalink
Add usage information to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Miikka Koskinen committed Jul 22, 2019
1 parent 141d54f commit ff498d6
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# clj-nvd

A sketch of using [lein-nvd](https://github.com/rm-hull/lein-nvd) with deps.edn.

## Usage

```sh
clojure -Sdeps '{:deps {clj-nvd {:git/url "https://github.com/miikka/clj-nvd.git" :sha "141d54f5304e53f6caa6e3de1677f3cfb04091f4"}}}' -m clj-nvd.core check
```

Alternatively, add clj-nvd as a git dependency to your `deps.edn`:

```clojure
{:aliases {:clj-nvd {:extra-deps {clj-nvd {:git/url "https://github.com/miikka/clj-nvd.git"
:sha "141d54f5304e53f6caa6e3de1677f3cfb04091f4"}}
:main-opts ["-m" "clj-nvd.core"]}}}
```

```sh
clojure -A:clj-nvd check
```

To specify the `:extra-deps` aliases to check, use `-A`:

```sh
clojure -A:clj-nvd check -A backend:frontend
```

0 comments on commit ff498d6

Please sign in to comment.