Skip to content

Commit c0fbc12

Browse files
committed
Add project information to README
1 parent ffe06d8 commit c0fbc12

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,44 @@
11
# Duct Shadow CLJS Compiler [![Build Status](https://github.com/duct-framework/compiler.cljs.shadow/actions/workflows/test.yml/badge.svg)](https://github.com/duct-framework/compiler.cljs.shadow/actions/workflows/test.yml)
22

3-
A Clojure library designed to ... well, that part is up to you.
3+
[Integrant][] methods for running [Shadow CLJS][]. Designed for
4+
the [Duct][] framework, but can be used in any Integrant configuration.
5+
6+
This library is still very new and API may change.
7+
8+
[duct]: https://github.com/duct-framework/duct
9+
[integrant]: https://github.com/weavejester/integrant
10+
[shadow cljs]: https://github.com/thheller/shadow-cljs
11+
12+
## Installation
13+
14+
Add the following dependency to your deps.edn file:
15+
16+
org.duct-framework/compiler.cljs.shadow {:mvn/version "0.1.0-SNAPSHOT"}
17+
18+
Or to your Leiningen project file:
19+
20+
[org.duct-framework/compiler.cljs.shadow "0.1.0-SNAPSHOT"]
421

522
## Usage
623

7-
FIXME
24+
This library provides Integrant methods for two keys:
25+
26+
- `:duct.compiler.cljs.shadow/release`
27+
- `:duct.compiler.cljs.shadow/server`
28+
29+
Both take the same configuration, but have different applications. The
30+
'release' key generates production-ready ClojureScript, while the
31+
'server' key starts a Shadow CLJS development server.
32+
33+
The options for both keys are the same as a `shadow-cljs.edn` file, with
34+
one notable exception; instead of a map of build configurations under
35+
the `:builds` option, there is a single build configuration under the
36+
`:build` key.
37+
38+
For more information, see the documentation on [Shadow CLJS
39+
configuration][config].
40+
41+
[config]: https://shadow-cljs.github.io/docs/UsersGuide.html#config
842

943
## License
1044

0 commit comments

Comments
 (0)