README.md in stairs-0.6.0 vs README.md in stairs-0.6.1
- old
+ new
@@ -138,16 +138,37 @@
setup :facebook, required: false
```
## Plugins for common setups
+Some steps support options. Options are specified as a hash like so:
+
+```ruby
+setup :step_name, option_1: "value", option_2: "value"
+```
+
### Built-in
-* `:secret_token` sets a secure random secret token
-* `:postgresql` quickly setup database.yml for use with PostgreSQL
-* `:facebook` interactive prompt for setting Facebook app credentials
+#### `:secret_token`
+Sets a secure random secret token. This will write the following ENV vars:
+`SECRET_TOKEN`
+
+#### `:postgresql`
+
+Quickly setup database.yml for use with PostgreSQL, including sensible defaults.
+
+#### `:facebook`
+
+Tnteractive prompt for setting Facebook app credentials. This will write the
+following ENV vars: `FACEBOOK_ID`, `FACEBOOK_SECRET`
+
+##### Options
+
+* `app_id`: ENV var name for Facebook App ID
+* `app_secret`: ENV var name for Facebook App Secret
+
### Available as independent gems
Any plugin that has specific dependencies on third party gems is shipped
independently to avoid maintaining those dependencies within Stairs.
@@ -198,10 +219,9 @@
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
## Credits
### Contributors