Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
verberktstan authored Jan 27, 2024
1 parent 7254267 commit d5e47e9
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,17 @@ All functionality *should* work in both Clojure and Clojurescript.

### Clojure CLI/deps.edn

Add this dependency to the :deps map in deps.edn
`org.clojars.stanv/swark {:mvn/version "0.1.21"}`
Add this dependency to the :deps map in deps.edn:

```org.clojars.stanv/swark {:mvn/version "0.1.21"}```

Require swark.core in your ns form:
`(:require [swark.core :as swark])`

```(:require [swark.core :as swark])```

Then you can use the Swark utility functions:
`(swark/key-by :id [{:id 1 :name "one"} {:id 2 :name "two"}])`

```(swark/key-by :id [{:id 1 :name "one"} {:id 2 :name "two"}])```

## Tests

Expand All @@ -30,10 +33,14 @@ Run the tests with `clojure -X:test/run`

Start a repl with `clojure -M:repl/reloaded`

Create an uberjar with `clj -X:uberjar :jar swark-x.x.x.jar` (replacing x's with version)
### Local installation

Install Swark locally with `clj -X:install`

### Jar creation

Create an uberjar with `clj -X:uberjar :jar swark-0.1.21.jar` (replacing x's with version)

## License

Swark by Stan Verberkt is marked with CC0 1.0 Universal

0 comments on commit d5e47e9

Please sign in to comment.