README.md in jstgenerator-0.0.1 vs README.md in jstgenerator-0.1.0
- old
+ new
@@ -15,10 +15,11 @@
$ bundle
## Usage
+### Within a Ruby app (such as Sinatra)
Within a Ruby app, you can do something like this:
```ruby
# or JstGenerator::Underscore.new for Underscore templates
JstGenerator::Handlebars.new({
@@ -44,14 +45,37 @@
```js
var html = window.JST["test"]({ title: "Hello World" });
```
-The advantage being the compilation step (`Handlebars.compile`) is only run once.
+The advantage being the compilation step (`Handlebars.compile`) is only run once and that you can keep your templates in their own file, rather than within some HTML.
+###Without a Ruby app (command line)
+
+```
+ $ gem install jstgenerator
+ $ jstgenerator [type] [glob] [output]
+```
+
+For example:
+
+```
+ $ jstgenerator handlebars "views/templates/**/*.hb" lib/js/jst.js
+```
+
+Make sure you quote the glob string, else your shell may well expand it for you, which you don't want in this case.
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+## Changelist
+
+__0.1.0__
+- added CLI tool
+
+__0.0.1__
+- initial release