Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update README.

  • Loading branch information...
commit dcaf21e359628f60baca53c701a0634326a29dec 1 parent 7b519b4
@jaredhanson authored
Showing with 30 additions and 0 deletions.
  1. +30 −0 README.md
View
30 README.md
@@ -1,5 +1,35 @@
# ltxb
+Less-Than XML builder templates for Node.js, based on [ltx](https://github.com/astro/ltx).
+
+## Installation
+
+ $ npm install ltxb
+
+## Usage
+
+ltxb is an [Express](http://expressjs.com/)-compatible template engine. It also
+exposes `compile` and `render` functions for integration with other frameworks.
+
+Define views using Less-Than XML builder syntax. `xml` is an instance of
+`Element` provided by the [ltx](https://github.com/astro/ltx) module. Refer to
+the [README](https://github.com/astro/ltx#building-xml-elements) for a complete
+syntax reference.
+
+ xml.n('hello')
+ .c(name);
+
+Render the view with in a route, passing locals to be substituted into the XML
+output.
+
+ res.render('hello.ltxb', { name: 'Dave' });
+
+## Tests
+
+ $ npm install --dev
+ $ make test
+
+[![Build Status](https://secure.travis-ci.org/jaredhanson/ltxb.png)](http://travis-ci.org/jaredhanson/ltxb)
## Credits
Please sign in to comment.
Something went wrong with that request. Please try again.