README.md in voom-presenters-0.1.13 vs README.md in voom-presenters-0.2.0
- old
+ new
@@ -72,15 +72,37 @@
[![Maintainability](https://api.codeclimate.com/v1/badges/8fcea717485230e60f27/maintainability)](https://codeclimate.com/github/rx/presenters/maintainability)
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=plastic)](https://raw.githubusercontent.com/rx/presenters/master/LICENSE)
## Usage
-TODO: Write usage instructions here
+To use it, add this line to your Gemfile:
+ gem 'voom-presenters'
+
+For rails: Mount the web-client in your rails config/routes.rb
+
+ mount ::Voom::Presenters::WebClient::App, at: '/'
+ # the api is optional
+ mount ::Voom::Presenters::Api::App, at: '/'
+
+
+Create the file app/presenters/index.pom with the contents:
+
+ Voom::Presenters.define(:index) do
+ heading 'hello world'
+ end
+
+Start your rails server and goto http://localhost:3000
+
+Use the demo to get example code to drop into your presetners.
+
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/rx/presenters.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+## Code of Conduct
+
+Everyone interacting in the Voom::Presenters project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rx/presenters/blob/master/CODE-OF-CONDUCT.md).