File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 22
33## Installation
44
5- For now the SDK and adapters are distributed as git dependencies using a ` deps.edn ` file.
5+ Install using clojars deps coordinates:
66
7- ``` clojure
8- {datastar/sdk {:git/url " https://github.com/starfederation/datastar/"
9- :git/sha " LATEST SHA"
10- :deps/root " sdk/clojure/sdk" }
7+ [ ![ Clojars Project] ( https://img.shields.io/clojars/v/dev.data-star.clojure/http-kit.svg )] ( https://clojars.org/dev.data-star.clojure/http-kit )
118
12- datastar/http-kit {:git/url " https://github.com/starfederation/datastar/"
13- :git/sha " LATEST SHA"
14- :deps/root " sdk/clojure/adapter-http-kit" }}
15- ```
16-
17- > [ !important]
18- > Replace ` LATEST_SHA ` in the git coordinates below by the actual latest commit sha of the repository.
9+ Don't forget, you need the base SDK also:
10+ [ ![ Clojars Project] ( https://img.shields.io/clojars/v/dev.data-star.clojure/sdk.svg )] ( https://clojars.org/dev.data-star.clojure/sdk )
Original file line number Diff line number Diff line change @@ -9,19 +9,9 @@ Any ring adapter using this protocol should work with this library.
99
1010## Installation
1111
12- For now the SDK and adapters are distributed as git dependencies using a ` deps.edn ` file.
12+ Install using clojars deps coordinates:
1313
14- ``` clojure
15- {datastar/sdk {:git/url " https://github.com/starfederation/datastar/"
16- :git/sha " LATEST SHA"
17- :deps/root " sdk/clojure/sdk" }
14+ [ ![ Clojars Project] ( https://img.shields.io/clojars/v/dev.data-star.clojure/ring.svg )] ( https://clojars.org/dev.data-star.clojure/ring )
1815
19- datastar/ring {:git/url " https://github.com/starfederation/datastar/"
20- :git/sha " LATEST SHA"
21- :deps/root " sdk/clojure/adapter-ring" }}
22- ```
23-
24- > [ !important]
25- >
26- > - Replace ` LATEST_SHA ` in the git coordinates below by the actual latest commit sha of the repository.
27- > - You also need to add a dependency to an actual ring compliant adapter.
16+ Don't forget, you need the base SDK also:
17+ [ ![ Clojars Project] ( https://img.shields.io/clojars/v/dev.data-star.clojure/sdk.svg )] ( https://clojars.org/dev.data-star.clojure/sdk )
Original file line number Diff line number Diff line change 22
33This library contains some utilities to work with Brotli.
44
5- Credits to [ Anders] ' (https://andersmurphy.com/ ) and his work on [ Hyperlith] ( https://github.com/andersmurphy/hyperlith )
5+ Credits to [ Anders] ( https://andersmurphy.com/ ) and his work on [ Hyperlith] ( https://github.com/andersmurphy/hyperlith )
66from which this library takes it's code.
77
88## Installation
99
10- ``` clojure
11- {datastar/brotli {:git/url " https://github.com/starfederation/datastar/"
12- :git/sha " LATEST SHA"
13- :deps/root " sdk/clojure/sdk-brotli" }
14-
15- ```
10+ Install using clojars deps coordinates:
1611
17- > [!important]
18- >
19- > - Replace `LATEST_SHA` in the git coordinates below by the actual latest
20- > commit sha of the repository.
21- > - You need to add a dependency for your specific plateform see the [Brotli4j page](https://github.com/hyperxpro/Brotli4j )
22- > For instance on linux `com.aayushatharva.brotli4j/native-linux-x86_64 {:mvn/version " 1.18.0" }}}`
12+ [ ![ Clojars Project] ( https://img.shields.io/clojars/v/dev.data-star.clojure/brotli.svg )] ( https://clojars.org/dev.data-star.clojure/brotli )
2313
2414## Supported ring adapters
2515
@@ -31,17 +21,17 @@ This library provides brotil write profiles you can use like this:
3121
3222``` clojure
3323(require
34- '[starfederation.datastar.clojure.api :as d*])
35- '[starfederation.datastar.clojure.adapter.Http-kit :as hk-gen])
36- '[starfederation.datastar.clojure.brotli :as brotli]))
24+ '[starfederation.datastar.clojure.api :as d*]
25+ '[starfederation.datastar.clojure.adapter.Http-kit :as hk-gen]
26+ '[starfederation.datastar.clojure.brotli :as brotli])
3727
3828(defn handler [req]
3929 (hk-gen/->sse-response
4030 {hk-gen/write-profile (brotli/->brotli-profile )
4131 hk-gen/on-open
4232 (fn [sse]
4333 (d*/with-open-sse sse
44- (do ...)} )
34+ (do ...))
4535```
4636
4737See docstrings in the `starfederation.datastar.clojure.brotli` namespace for
Original file line number Diff line number Diff line change 22
33## Installation
44
5- For now the SDK and adapters are distributed as git dependencies using a ` deps.edn ` file.
5+ Install using clojars deps coordinates:
66
7- ``` clojure
8- {datastar/malli-schemas {:git/url " https://github.com/starfederation/datastar/"
9- :git/sha " LATEST SHA"
10- :deps/root " sdk/clojure/malli-schemas" }}
11- ```
12-
13- > [ !important]
14- > Replace ` LATEST_SHA ` in the git coordinates below by the actual latest commit sha of the repository.
7+ [ ![ Clojars Project] ( https://img.shields.io/clojars/v/dev.data-star.clojure/malli-schemas.svg )] ( https://clojars.org/dev.data-star.clojure/malli-schemas )
158
169## Usage
1710
@@ -25,3 +18,4 @@ Notable schema namespaces:
2518- ` starfederation.datastar.clojure.adapter.common-schemas ` for the common adapter machinery (write profiles)
2619- ` starfederation.datastar.clojure.adapter.http-kit-schemas ` for the http-kit adapter
2720- ` starfederation.datastar.clojure.adapter.ring-schemas ` for the ring adapter
21+
Original file line number Diff line number Diff line change @@ -4,15 +4,6 @@ This is where the code for the Generic SDK lives.
44
55## Installation
66
7- For now the SDK and adapters are distributed as git dependencies using a ` deps.edn ` file.
8- If you roll your own adapter you only need:
7+ Install using clojars deps coordinates:
98
10- ``` clojure
11- {datastar/sdk {:git/url " https://github.com/starfederation/datastar/tree/develop"
12- :git/sha " LATEST SHA"
13- :deps/root " sdk/clojure/sdk" }}
14- ```
15-
16- > [ !important]
17- > This project is new and there isn't a release process yet other than using git shas.
18- > Replace ` LATEST_SHA ` in the git coordinates below by the actual latest commit sha of the repository.
9+ [ ![ Clojars Project] ( https://img.shields.io/clojars/v/dev.data-star.clojure/sdk.svg )] ( https://clojars.org/dev.data-star.clojure/sdk )
You can’t perform that action at this time.
0 commit comments