Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruce Hauman committed Feb 5, 2015
1 parent c906c6b commit b9da01d
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ Here is a [live demo of figwheel](https://www.youtube.com/watch?v=KZjFVdU8VLI)

See the introductory blog post [here](http://rigsomelight.com/2014/05/01/interactive-programming-flappy-bird-clojurescript.html).

The last version: [lein-figwheel "0.2.1-SNAPSHOT"](https://clojars.org/lein-figwheel)
[lein-figwheel "0.2.1-SNAPSHOT"](https://clojars.org/lein-figwheel)
supports clojurescript >= 0.0-2202

Current version: [lein-figwheel "0.2.2-SNAPSHOT"](https://clojars.org/lein-figwheel) requires
Current version: [lein-figwheel "0.2.3-SNAPSHOT"](https://clojars.org/lein-figwheel) requires
clojurescript >= 0.0-2665, and will work even better with the comming
releases.

lein-figwheel "0.2.2-SNAPSHOT" has a built-in ClojureScript REPL that is attached to
your running application. All the instructions below are for "0.2.2-SNAPSHOT"
lein-figwheel "0.2.3-SNAPSHOT" has a built-in ClojureScript REPL that is attached to
your running application. All the instructions below are for "0.2.3-SNAPSHOT"

![Figwheel heads up example](https://s3.amazonaws.com/bhauman-blog-images/figwheel_image.png)

Expand All @@ -29,6 +29,10 @@ modifying your code in real time. This is different than interactive
programming in the browser-repl where you need to cherry pick which
changes to send and which processes to start, etc.

#### Supports Node.js

You can use fighweel and to live code in Node.js with ClojureScript!

#### Static file server

The inclusion of a **static file server** allows you to get a decent
Expand Down Expand Up @@ -115,15 +119,15 @@ First make sure you include the following `:dependencies` in your `project.clj`

```clojure
[org.clojure/clojurescript "0.0-2665"] ;; has to be at least 2665 or greater
[figwheel "0.2.2-SNAPSHOT"] ;; needed for figwheel client
[figwheel "0.2.3-SNAPSHOT"] ;; needed for figwheel client
```

Then include `lein-figwheel` along with `lein-cljsbuild` in the `:plugins`
section of your project.clj.

```clojure
[lein-cljsbuild "1.0.4"] ;; 1.0.4 is a requirement
[lein-figwheel "0.2.2-SNAPSHOT"]
[lein-figwheel "0.2.3-SNAPSHOT"]
```

#### Configure lein cljsbuild
Expand Down Expand Up @@ -214,7 +218,7 @@ In your `project.clj` you can add the following configuration parameters:
In your project.clj you need to include figwheel in your dependencies.

```clojure
[figwheel "0.2.2-SNAPSHOT"]
[figwheel "0.2.3-SNAPSHOT"]
```

Make sure you have setup an html file to host your cljs. For example
Expand Down Expand Up @@ -299,6 +303,17 @@ file:
(ns ^:figwheel-load example.core)
```

It can be very helpful to have a file reload every time a file changes
in your ClojureScript source tree. This can facilitate reloading your
main app and running tests on change.

To force a file to reload on every change:

```clojure
(ns ^:figwheel-always example.test-runner)
```


### Using your own server

You do not have to use the figwheel server to host your app and its
Expand Down

0 comments on commit b9da01d

Please sign in to comment.