README.md in stairs-0.5.1 vs README.md in stairs-0.6.0
- old
+ new
@@ -42,23 +42,33 @@
require "stairs/tasks"
```
## Usage
+### Basic
+
In an app with a `setup.rb`, just run the rake task:
```
$ rake newb
```
+### Advanced
+
+If you want more control, use the `stairs` command line utility:
+
+```
+$ stairs --help
+Usage: stairs [options]
+ --use-defaults Use defaults when available
+```
+
## Defining scripts
A script composes many steps that setup a project.
```ruby
-bundle
-
setup :secret_token
setup :s3
setup :zencoder, required: false
@@ -102,15 +112,10 @@
write_line "more: false", "config/settings.yml"
```
### Misc helpers
-Run bundle to install gems
-```ruby
-bundle
-```
-
Run rake tasks
```ruby
rake "task_name"
```
@@ -164,12 +169,9 @@
```
$ rake newb
Looks like you're using rbenv to manage environment variables. Is this correct? (Y/N): Y
= Running script setup.rb
-== Running bundle
-...
-== Completed bundle
== Running S3
AWS access key: 39u39d9u291
AWS secret: 19jd920i10is0i01i0s01ks0kfknkje
Do you have an existing bucket? (Y/N): Y
Bucket name (leave blank for app-dev): my-cool-bucket