This repository has been archived by the owner on Aug 8, 2018. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,27 @@ | ||
= Bento | ||
== Bento | ||
|
||
Bento is a Rails account management engine | ||
Bento is a Rails account management engine. | ||
|
||
== Disclaimer | ||
|
||
Don't expect anything work in any way as described below! | ||
|
||
== Requirements | ||
|
||
Currently it has a lot of pre conditions. The goal is to get rid of as many of them as possible but right new Bento expects the following: | ||
* Your model for managing accounts is named Account (Bento can generate it for you) | ||
* The account model has a name and a plan column (Bento can generate the migrations too) | ||
* You have a model named User to keep track of users | ||
- The users has a first_name, last_name, email and password fields | ||
|
||
== Installation | ||
|
||
gem install bento | ||
rails generate bento account | ||
rake db:migrate | ||
|
||
== Basic Usage | ||
|
||
Bento sets up the following routes that you can use, complete with views and controllers: | ||
* [GET] new_accounts | ||
* [POST] accounts |