README.md in stairs-0.1.0 vs README.md in stairs-0.2.0
- old
+ new
@@ -1,15 +1,16 @@
# Stairs
A DSL and collection of plugins for easy setup of projects on new development
-environments.
+environments. Write a script that new devs can run for an interactive setup.
+For environment variables, Stairs supports rbenv-vars, RVM, and dotenv.
## Setup
1. Install gem `stairs`
-1. Require tasks in Rakefile
+1. Require tasks in `Rakefile`
```ruby
require "stairs/tasks"
```
1. [Define your script](#defining-scripts) in `setup.rb` at the root of your
@@ -39,11 +40,12 @@
puts "Sweet you're good to go. Just run `rails s` and `sidekiq` to get rolling!"
```
### Example CLI
-Given the above script, the CLI would look like this:
+Given the above script, the CLI might look like this. __Note:__ some of this
+is desired future functionality (bundle/db tasks, spacing, last words).
```
$ rake newb
... bundle install
... db setup + seed
@@ -67,11 +69,11 @@
## DSL
### Collecting values
```ruby
value = provide "Something"
-value = provide "Another", required: false
+value = provide "Another", required: false # Not fully implemented
provide "More", default: "a-default"
```
### Asking questions
```ruby
@@ -109,15 +111,20 @@
setup :s3
```
## Plugins for common setups
+### Built-in
* `:secret_token` sets a secure random secret token
+
+### Available as extension gems
* `:s3` interactive prompt for setting AWS + S3 bucket access credentials:
[patbenatar/stairs-steps-s3][s3]
-* `:balanced`: automatically creates a test Marketplace on Balanced:
+* `:balanced` automatically creates a test Marketplace on Balanced:
[patbenatar/stairs-steps-balanced][balanced]
+* `:facebook` interactive prompt for setting Facebook app credentials:
+ [patbenatar/stairs-steps-facebook][facebook]
### Defining custom plugins
Steps inherit from `Stairs::Step`, have a title, description, and
implement the `run` method. See those included and in the various
@@ -130,6 +137,7 @@
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
[s3]: http://github.com/patbenatar/stairs-steps-s3
-[balanced]: http://github.com/patbenatar/stairs-steps-balanced
+[balanced]: http://github.com/patbenatar/stairs-steps-balanced
+[facebook]: http://github.com/patbenatar/stairs-steps-facebook
\ No newline at end of file