README.md in papa-0.6.2 vs README.md in papa-0.7.0
- old
+ new
@@ -1,29 +1,49 @@
-# Papa [](https://badge.fury.io/rb/papa) [](https://travis-ci.org/b-ggs/papa)
+# Papa [](https://rubygems.org/gems/papa) [](https://travis-ci.org/b-ggs/papa)
Helper tool for inDinero's git workflow. Ako ang papa mo.
## Contents
* [Getting Started](#getting-started)
* [Commands](#commands)
* [papa release](#papa-release)
+ * [start](#starting-a-release-branch)
+ * [add](#adding-feature-branches-to-a-release-branch)
+ * [finish](#finishing-a-release-branch)
* [papa hotfix](#papa-hotfix)
+ * [start](#starting-a-hotfix-branch)
+ * [add](#adding-bugfix-branches-to-a-hotfix-branch)
+ * [deploy](#deploying-a-hotfix-branch-to-a-hotfix-environment)
+ * [finish](#finishing-a-hotfix-branch)
* [papa integration](#papa-integration)
- * [papa deploy](#papa-deploy)
+ * [start](#starting-an-integration-branch)
+ * [add](#adding-branches-to-an-integration-branch)
+ * [deploy](#deploying-an-integration-branch-to-an-integration-environment)
* [papa sandbox](#papa-sandbox)
+ * [generate](#papa-sandbox)
## Getting Started
-Install `papa` from Rubygems.
+### Install `papa` from Rubygems
```
$ gem install papa
```
-That's it, you're ready to go!
+### Set up configs
+Create a config file in `~/.papa.config.yml`.
+
+An example config file can be found in `.papa.config.yml.example`.
+
+tl;dr:
+
+```
+echo 'slack_webhook: YOUR_SLACK_WEBHOOK_URL_HERE' > ~/.papa.config.yml
+```
+
## Usage
Detailed information about what these commands do can be found in [USAGE.md](https://github.com/b-ggs/papa/blob/master/USAGE.md).
### `papa release`
@@ -84,10 +104,14 @@
```
#### Finishing a hotfix branch
```
-$ papa release hotfix -v 17.12.0
+$ papa hotfix finish -v 17.12.0
+```
+
+```
+$ papa hotfix finish -v 17.12.0 -b release/17.11.0
```
### `papa integration`
#### Starting an integration branch