README.md in cas-cms-0.1.3 vs README.md in cas-cms-1.0.0.alpha1
- old
+ new
@@ -1,44 +1,54 @@
# Cas
-Short description and motivation.
## Usage
-How to use my plugin.
-
-## Installation
-
Add this line to your application's Gemfile:
```ruby
gem 'cas'
```
-### Setup
+### Installation
-**Engine:** Cas is mounted in your main Rails application. Say your application
-is called MyBlog, you make can make it accessible at `myblog.com/admin`
-by setting the following in the `config/routes.rb` file in your main
-application:
+```
+bin/rails generate cas:install
+```
-```ruby
-Rails.application.routes.draw do
- mount Cas::Engine, at: "/admin"
+This adds an `/admin` entry to `config/routes.rb` and generates a new file,
+`config/cas.config.yml` which contains all sections your site is supposed to
+have.
- # ... other routes
-end
+Once the file is edited, run
+
```
+bin/rails cas:apply_config
+```
-**S3:** you need S3 credentials to use Cas (for file uploads). Set the
+### File Uploads
+
+You need S3 credentials to use Cas (for file uploads). Set the
following ENV vars (e.g paste in your `~/.bash_profile` or use the `dotenv`
gem in your main Rails application):
export S3_ACCESS_KEY_ID="value"
export S3_SECRET_ACCESS_KEY="value"
export S3_REGION="value"
export S3_BUCKET="value"
-## Contributing
-Contribution directions go here.
+## Development
+Quick start:
+
+```
+bundle install
+bundle exec rake db:create db:migrate db:test:prepare
+cd spec/test_app/ && bin/rails server
+```
+
+### The Longer Version
+
+
+
## License
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).