Skip to content

Commit

Permalink
Merge pull request #11 from dciccale/master
Browse files Browse the repository at this point in the history
added some todos and small changes to readme
  • Loading branch information
julien committed Jul 13, 2012
2 parents fbb32e3 + 5a2b0f1 commit 178e643
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Expand Up @@ -2,23 +2,30 @@

[Espresso](http://www.espressoboilerplate.org) is a little boilerplate you can use to create [Express](http://www.expressjs.com) apps along with [CoffeeScript](http://www.coffeescript.org), [Jade](http://jade-lang.com/) and [Stylus](http://learnboost.github.com/stylus).


## How to
1. Download the zip file and unzip it
2. Run `npm install` command line inside the project directory
3. Run `coffee app.coffee` and you'r done! just open a browser and type `http://localhost:3000`
*Optional:*
Run with `-p` or `--production` to compile the generated CoffeeScript
3. Run `coffee app.coffee` and you'r done! just open a browser and type `http://localhost:3000`


## Minification
JS minification is done with [UglifyJS](https://github.com/mishoo/UglifyJS)
Run Espresso with `coffee app.coffee -p` to minify the generated CoffeeScript


## Todo
1. Create an NPM module *in progress*
1. Create Espresso as an NPM module *in progress*
2. Add [Mocha](http://visionmedia.github.com/mocha) as testing framework?
3. Better [Espresso website](http://www.espressoboilerplate.org) and documentation
4. Allow custom build


## Authors
- [Julien Castelain](http://twitter.com/__juju__)
- [Denis Ciccale](http://twitter.com/tdecs)
- [Sergio Ruiz] (http://twitter.com/serginator)
- [Sergio Ruiz](http://twitter.com/serginator)


## License
See [LICENSE.txt](https://raw.github.com/dciccale/espresso-boilerplate/master/LICENSE.txt)
See [LICENSE.txt](https://raw.github.com/dciccale/espresso-boilerplate/master/LICENSE.txt)

0 comments on commit 178e643

Please sign in to comment.