README.md in stairs-0.3.0 vs README.md in stairs-0.4.0
- old
+ new
@@ -1,23 +1,40 @@
# Stairs
-A DSL and collection of plugins for easy setup of projects on new development
-environments. Write a script that new devs can run for an interactive setup.
-For environment variables, Stairs supports rbenv-vars, RVM, and dotenv.
+It's a pain to setup new developers. Stairs is a utility and framework from
+which to write scripts for faster and easier setup of apps in new development
+environments. Scripts try to automate as much as possible and provide
+interactive prompts for everything else.
+Stairs currently supports writing environment variables for rbenv-vars, RVM,
+and dotenv.
+
+[](https://travis-ci.org/patbenatar/stairs)
+[](https://codeclimate.com/github/patbenatar/stairs)
+
## Setup
-1. Install gem `stairs`
+### Rails
-1. Require tasks in `Rakefile`
+Add Stairs to your `Gemfile`:
+
```ruby
-require "stairs/tasks"
+gem "stairs"
```
-1. [Define your script](#defining-scripts) in `setup.rb` at the root of your
- project
+[Define your script](#defining-scripts) in `setup.rb` at the root of your
+project.
+### Not Rails
+
+Same as above, but you'll have to manually add the Stairs Rake tasks to your
+`Rakefile`.
+
+```ruby
+require "stairs/tasks"
+```
+
## Usage
In an app with a `setup.rb`, just run the rake task:
```
@@ -170,6 +187,19 @@
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
[s3]: http://github.com/patbenatar/stairs-steps-s3
[balanced]: http://github.com/patbenatar/stairs-steps-balanced
-[facebook]: http://github.com/patbenatar/stairs-steps-facebook
\ No newline at end of file
+[facebook]: http://github.com/patbenatar/stairs-steps-facebook
+
+## Credits
+
+### Contributors
+
+* [Nick Giancola](https://github.com/patbenatar)
+* [Brendan Loudermilk](https://github.com/bloudermilk)
+
+### Sponsor
+
+[](http://gophilosophie.com)
+
+This gem is maintained partially during my open source time at [philosophie](http://gophilosophie.com).