houston/houston-core

View on GitHub
templates/new-module/README.md

Summary

Maintainability
Test Coverage
# Houston::<%= camelized %>

TODO: Summary of Houston <%= camelized %>.


## Installation

In your `Gemfile`, add:

    gem "houston-<%= name %>"

And in `config/main.rb`, add:

```ruby
use :<%= name %> do
  # TODO: specify configuration options for Houston::<%= camelized %> here
end
```

And then execute:

    $ bundle


## 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