Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adamstallard committed Aug 27, 2013
1 parent 662bc43 commit af62232
Showing 1 changed file with 7 additions and 14 deletions.
21 changes: 7 additions & 14 deletions README.md
Expand Up @@ -25,7 +25,7 @@
3. Clean separation of languages: javascript is javascript and HTML is HTML. Get rid of HTML snippets inside javascript. 3. Clean separation of languages: javascript is javascript and HTML is HTML. Get rid of HTML snippets inside javascript.
4. Less logic than "logicless" templates. It doesn't turn HTML into a programming language. 4. Less logic than "logicless" templates. It doesn't turn HTML into a programming language.
5. Use stand-alone or with a framework, e.g. [backbone](https://github.com/documentcloud/backbone), 5. Use stand-alone or with a framework, e.g. [backbone](https://github.com/documentcloud/backbone),
[meteor](https://github.com/meteor/meteor, etc. [meteor](https://github.com/meteor/meteor), etc.
6. Use "demo" elements to preview a design--they go away when compiled for production. 6. Use "demo" elements to preview a design--they go away when compiled for production.
7. Pass-through parameters are easier than "partials." [Documentation and Example](https://github 7. Pass-through parameters are easier than "partials." [Documentation and Example](https://github
.com/goalzen/modest/wiki/Documentation#wiki-passthrough-parameters) .com/goalzen/modest/wiki/Documentation#wiki-passthrough-parameters)
Expand All @@ -36,24 +36,17 @@


###Installation[_*_](#prerequisites) ###Installation[_*_](#prerequisites)


Preview/Demo Use: #### Preview/Demo


Download [modest-preview.js](https://raw.github.com/goalzen/modest/master/lib/modest-preview.js). Download [modest-preview.js](https://raw.github.com/goalzen/modest/master/lib/modest-preview.js).


Production Use: #### Compile to Production


1. [Install node.js](http://nodejs.org/#download) 1. [Install node.js](http://nodejs.org/#download)
2. ``npm install -g modest`` 2. ``npm install -g modest``

3a. ``modest``
###Command Line --OR--

3b. [grunt-modest](https://github.com/goalzen/grunt-modest?source=cc)
```bash
modest
```

###Grunt

[grunt-modest](https://github.com/goalzen/grunt-modest?source=cc)


###Report Bugs ###Report Bugs
https://github.com/goalzen/modest/issues https://github.com/goalzen/modest/issues
Expand All @@ -62,7 +55,7 @@ https://github.com/goalzen/modest/issues


[modest-preview.js](https://raw.github.com/goalzen/modest/master/lib/modest-preview.js) runs in the browser, and depends on [jquery](http://jquery.com/download/). [modest-preview.js](https://raw.github.com/goalzen/modest/master/lib/modest-preview.js) runs in the browser, and depends on [jquery](http://jquery.com/download/).


The modest compiler has the following prerequisites: To compile to production, you need:


* [node.js](http://nodejs.org/download/) * [node.js](http://nodejs.org/download/)
* Python * Python
Expand Down

0 comments on commit af62232

Please sign in to comment.