README.md in tiny-rails-0.0.2 vs README.md in tiny-rails-0.1.0
- old
+ new
@@ -1,16 +1,30 @@
# TinyRails
Scaffold for tiny Rails apps based on José Valim's Rails Lightweight Stack
[code](https://gist.github.com/1942658)
+
## Installation
Install it using:
$ gem install tiny-rails
+
+## WTF?! Why would I use this?
+
+Although the generated application code could be used on a production server,
+the idea is to try to give you a really basic application to try out new Rails
+gems, create spikes and to provide an isolated small Rails environment for
+reproducing bugs to support bug reports.
+
+You could also use this to create a single page application with all rails
+features like code reloading and the asset pipeline without having to set up
+a Sinatra application from the ground app.
+
+
## Usage
```terminal
$ tiny-rails new tiny-app
create
@@ -26,11 +40,15 @@
This will give you a pretty basic application that you can run with `rackup`
or you prefferend server. It even supports code reloading for the generated
controller!
+You can also fire up a console to play around with the generated app running
+`tiny-rails console`. If you want to use Pry, you can just add the `pry-rails`
+gem to your Gemfile.
+
## Addons
You can provide the `-a` parameter when creating new apllications to enable a
list of "addons" on the generated app. For example:
@@ -52,9 +70,12 @@
folder.
Here's a list of the addons bundled with the gem:
* [activerecord](https://github.com/fgrehm/tiny-rails/blob/master/addons/activerecord.rb)
+* [coffeescript](https://github.com/fgrehm/tiny-rails/blob/master/addons/coffeescript.rb)
+* [jquery](https://github.com/fgrehm/tiny-rails/blob/master/addons/jquery.rb)
+* [client_side_validations](https://github.com/fgrehm/tiny-rails/blob/master/addons/client_side_validations.rb)
### Building your own addon
The API for writing addon scripts are based on Rails'