diff --git a/README.md b/README.md index d7728e5..98c7e7e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # garden -A Leiningen plugin for [garden] lib that automatically compiles garden files to css. +A Leiningen plugin for compiling [garden](https://github.com/noprompt/garden) to css. -## Usage +## Install Add lein-garden to plugins section in `project.clj`: @@ -17,6 +17,13 @@ Add garden config to `project.clj`: :output-path "resources/css"} ``` +### Usage + +lein-garden provides 2 tasks: + +* `lein garden once` - compiles garden files to css once +* `lein garden auto` - compiles garden files to css on every change + ## File format Garden files are usual clojure files (*.clj). Plugin reads all expressions from clj files, evaluates them, retains vectors and garden.types.CSSAtRule values and compiles them to css.