diff --git a/README.md b/README.md index 096849c..2b32f4b 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Chinstrap uses 4 stages for successfully rendering mustache templates. The scanner runs through the template and emits single characters to work with. In the next stage the lexer creates meaningful (in the mustache context) tokens of the retrieved characters. These token are then given to the parser, which knows -the [state machine]() to render mustache templates and creates a parse tree +the state machine to render mustache templates and creates a parse tree based on it. The parse tree is then passed to the renderer along with the context to create the rendered template. @@ -34,20 +34,21 @@ context to create the rendered template. make all install ## Dependencies -- [yajl](https://github.com/lloyd/yajl) for unit testing +- [check](http://check.sourceforge.net/) for unit testing ## Meta - [Bugs](http://github.com/chinstrap/issues) -- [Features](https://pivotaltracker.com/000000) ## Contribute If you want to contribute: - Fork the project. - Make your feature addition or bug fix based on develop. -- Add tests for it. This is important so I don’t break it in a future version unintentionally. +- Add tests for it. This is important so I don't break it in a future version + unintentionally. - Commit, do not mess with version - Send me a pull request. Bonus points for topic branches. ## Related -- If you want a more data model agnostic parser checkout [crustache]() +- If you want a more data model agnostic parser checkout +[crustache](https://github.com/tanoku/crustache)