README.md in paratrooper-0.4.0 vs README.md in paratrooper-1.0.0
- old
+ new
@@ -1,11 +1,13 @@
-# Paratrooper
+## Paratrooper
-Library for handling common tasks when deploying to [Heroku](http://heroku.com)
-
+[](http://badge.fury.io/rb/paratrooper)
[](https://travis-ci.org/mattpolito/paratrooper)
+[](https://codeclimate.com/github/mattpolito/paratrooper)
+Make your complex deploy to [Heroku][] easy.
+
## Installation
Add this line to your application's Gemfile:
gem 'paratrooper'
@@ -18,12 +20,10 @@
$ gem install paratrooper
## Usage
->> Note: Before getting started, ensure that `ENV['HEROKU_API_KEY']` is set. If you do not know your api key, you can `cat ~/.netrc`. Your api key will be listed as password in that file. This is necessary until reading your crendentials out of the `.netrc` file is implemented.
-
Instantiate Paratrooper with the name of your heroku application
```ruby
Paratrooper::Deploy.new('amazing-app')
```
@@ -34,10 +34,34 @@
Paratrooper::Deploy.new('amazing-app', tag: 'staging')
```
Then there are methods available to perform common tasks like creating git tags, running migrations, and warming your application instance.
+## Authentication
+
+Authentication with your Heroku account can happen in a few different ways
+
+* Providing API Key
+
+```ruby
+Paratrooper::Deploy.new('app', api_key: 'API_KEY')
+```
+
+* Via environment variable
+
+```ruby
+ENV['HEROKU_API_KEY'] = 'API_KEY'
+Paratrooper::Deploy.new('app')
+```
+
+* Local file storage
+ This method works via a local Netrc file. Storage of this key is handled via the [Heroku Toolbelt][]. This is the default and preferred method of providing your authentication key.
+
+```ruby
+Paratrooper::Deploy.new('app')
+```
+
## Sensible Default Deployment
You can use the objects methods any way you'd like but we've provided a sensible default at `Paratrooper#deploy`
This will perform the following tasks:
@@ -70,12 +94,21 @@
deployment.deploy
end
end
```
+## Nice to haves
+
+* deploy to heroku from tags
+* send [New Relic][] a notification to toggle heartbeat during deploy
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
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
+
+[Heroku]: http://heroku.com
+[Heroku Toolbelt]: http://toolbelt.heroku.com
+[New Relic]: http://newrelic.com