Permalink
Browse files

updated README, docs

  • Loading branch information...
1 parent c51e4d7 commit 845ca311b7ffa6cb0d3c7f1bc81d0bffbe35792d akdubya committed Oct 26, 2010
Showing with 58 additions and 4 deletions.
  1. +45 −0 README.md
  2. +6 −2 docs/api.md
  3. +7 −2 index.html
View
@@ -0,0 +1,45 @@
+Dust
+====
+
+> Asynchronous templates for the browser and node.js
+
+#### <http://akdubya.github.com/dustjs> #
+
+Why?
+----
+
+I like [Mustache](http://mustache.github.com) and variants but none of them offer quite what I need.
+
+Use Dust if you want these things:
+
+* async/streaming operation
+* browser/node compatibility
+* extended Mustache/ctemplate syntax
+* clean, low-level API
+* [high performance](http://akdubya.github.com/dustjs/benchmark/index.html)
+* composable templates
+
+Composable templates?
+---------------------
+
+ {^xhr}
+ {>base_template/}
+ {:else}
+ {+main/}
+ {/xhr}
+ {<title}
+ Child Title
+ {/title}
+ {<main}
+ Child Content
+ {/main}
+
+Installation
+------------
+
+ $ npm install dust
+
+Demo & Guide
+------------
+
+Extensive docs and a full demo are available at <http://akdubya.github.com/dustjs>
View
@@ -2,9 +2,13 @@ A pure JavaScript library, Dust is runs in both browser-side and server-side env
### Installation
-To run Dust within Node.js, clone the repository and require `dust.js`:
+To run Dust within Node.js, first install via [npm](http://github.com/isaacs/npm):
- var dust = require("path/to/dust/lib/dust");
+ npm install dust
+
+Then, within your Node script or the REPL:
+
+ var dust = require('dust');
This will import everything needed to parse, compile and render templates.
View
@@ -714,9 +714,14 @@
<h3>Installation</h3>
-<p>To run Dust within Node.js, clone the repository and require <code>dust.js</code>:</p>
+<p>To run Dust within Node.js, first install via <a href="http://github.com/isaacs/npm">npm</a>:</p>
-<pre><code>var dust = require("path/to/dust/lib/dust");
+<pre><code>npm install dust
+</code></pre>
+
+<p>Then, within your Node script or the REPL:</p>
+
+<pre><code>var dust = require('dust');
</code></pre>
<p>This will import everything needed to parse, compile and render templates.</p>

0 comments on commit 845ca31

Please sign in to comment.