README.md in appscrolls-0.7.1 vs README.md in appscrolls-0.8.0
- old
+ new
@@ -9,10 +9,11 @@
```
The App Scrolls is a magical tool to generate new Rails and modify existing Rails applications (coming) to include your favourite, powerful magic. Authentication, testing, persistence, javascript, css, deployment, and templating - there's a magical scroll for you.
* Follow on twitter [@appscrolls][9]
+* [![Build Status](https://secure.travis-ci.org/drnic/appscrolls.png?branch=master)](http://travis-ci.org/drnic/appscrolls)
An example application that was built by the App Scrolls is at [https://github.com/drnic/mydemoapp][14]. The generated README shows all the scrolls that were included.
## Installation
@@ -23,32 +24,47 @@
## Usage
The primary usage of the `appscrolls` gem is to utilize its interactive terminal command to build a new Rails application. To get started, you can simply run the command thusly:
appscrolls new APP_NAME
+ scrolls new APP_NAME
Where `APP_NAME` is the directory in which you wish to create the app (it mirrors the Rails creation syntax). You will then be guided through the scroll selection process and subsequently the Rails app generator will automatically run with the template and all appropriate command line options included.
To transform an existing Rails app, you ... wait, that's not implemented yet. But since the "apply template" feature of `rails new APP_NAME -m template.rb` is implemented in Thor, I mean, how hard could it be?*
+### Available Scrolls
+
+The current available scrolls grouped by category:
+
+* administration: active_admin
+* assets: jquery, prototype
+* deployment: eycloud, eycloud_recipes_on_deploy, git, github, passenger, thin, unicorn
+* persistence: mysql, postgresql, redis, sqlite3
+* stylesheet: twitter_bootstrap
+* templating: simple_form
+* testing: capybara, cucumber, rspec, test_unit
+* worker: delayed_job, resque
+* other: env_yaml, guard, rails_basics, split
+
### Specifying Scrolls
If you wish to skip the interactive scroll selector, you may provide instead a list of scrolls with the `-s` or `--scrolls` option:
- appscrolls new APP_NAME -s twitter_bootstrap mysql resque
- appscrolls new APP_NAME --scrolls postgresql github eycloud
+ scrolls new APP_NAME -s twitter_bootstrap mysql resque
+ scrolls new APP_NAME --scrolls postgresql github eycloud
This will automatically generate a Rails template with the provided scrolls and begin the app generator.
### Listing Scrolls
You can also print out a simple list of scrolls:
- appscrolls list
+ scrolls list
Or print out a list of scrolls for a specific category:
- appscrolls list persistence
+ scrolls list persistence
## Deployment Support
Web applications are boring if they aren't running proudly on the internet. The App Scrolls make this automatic for your favourite providers!
\ No newline at end of file