readme: example

bem · Apr 24, 2013 · 838a4f0 · 838a4f0
1 parent 31ead37
commit 838a4f0
Showing 1 changed file with 20 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,20 @@
-# BEMHTML.js
+# BEMHTML.js [![Build Status](https://secure.travis-ci.org/indutny/bemhtml.js.png)](http://travis-ci.org/indutny/bemhtml.js)
+
+Compiler for a BEMHTML matching/template engine.
+
+## Usage:
+
+```javascript
+var bemhtml = require('bemhtml');
+
+var template = bemhtml.compile('... your source code ...');
+
+template.apply.call({
+  block: 'b-link',
+  tag: 'a',
+  attrs: {
+    href: 'http://news.ycombinator.com'
+  },
+  content: 'Hacker News'
+});
+```