Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
halogenandtoast committed May 5, 2014
1 parent c300a17 commit b922196
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Monban::Generators

TODO: Write a gem description
Rails generators for adding in authentication components.

## Installation

Expand All @@ -12,13 +12,25 @@ And then execute:

$ bundle

Or install it yourself as:
## Generators

$ gem install monban-generators
Currently there are two generators available, but over time more will be added:

## Usage
### Scaffold

TODO: Write usage instructions here
You can generate a basic starting point for any monban app by running the following:

rails g monban:scaffold

### Password Reset

If you'd like to generate basic password reset for your app, you can run:

rails g monban:password_reset

This will generate the necessary files for an implementation of resetting
a user's password. It will ask you for host names for development, test
and production environments in order to make the mailer work.

## Contributing

Expand Down

0 comments on commit b922196

Please sign in to comment.