README.md in web_app_template-0.0.1 vs README.md in web_app_template-0.0.2
- old
+ new
@@ -1,8 +1,9 @@
# WebAppTemplate
-TODO: Write a gem description
+Web App Template is a rails generator that you can use to generate site templates quickly.
+Today some bootstrap v3 templates already available to generate layouts.
## Installation
Add this line to your application's Gemfile:
@@ -16,14 +17,34 @@
$ gem install web_app_template
## Usage
-TODO: Write usage instructions here
+### Layout generator
+Used without parameters, it generates the layout inside the application.html.erb file using the bootstrap template "Starter".
+
+ rails g web_app_template:layout
+
+You can specify the layout file name in the first parameter:
+
+ rails g web_app_template:layout admin # it will generate a layout called `admin.html.erb`
+
+If you want to use another bootstrap template layout, instead of the default, you can use the `--template` option:
+
+ rails g web_app_template:layout admin --template="jumbotron"
+
+You can specify the template engine with `--engine=name` option, where name can be erb (default), haml or slim:
+
+ rails g web_app_template:layout --engine=slim # you must specify slim in your Gemfile
+
+You can specify the text used in the header with the `--app-name` option:
+
+ rails g web_app_template:layout --app-name="My New Application"
+
## Contributing
-1. Fork it ( http://github.com/<my-github-username>/web_app_template/fork )
+1. Fork it ( http://github.com/jurrick/web_app_template/fork )
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