Merge branch 'master' of github.com:aureliosaraiva/ember-cli-deploy-github-deployments

Author: aureliosaraiva

README.md

@@ -1,9 +1,8 @@
 # ember-cli-deploy-github-deployments
 
-> An ember-cli-deploy-plugin for setting the status on a commit in a PR on [GitHub](https://github.com/).
+> An ember-cli-deploy-plugin for setting the status deploy on a commit in a PR on [GitHub](https://github.com/).
 
-[![](https://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/plugins/ember-cli-deploy-github-deployments.svg)](http://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/)
-[![Ember Observer Score](http://emberobserver.com/badges/ember-cli-deploy-github-deployments.svg)](http://emberobserver.com/addons/ember-cli-deploy-github-deployments)
+[![](https://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/plugins/ember-cli-deploy-s3.svg)](http://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/)
 [![npm version](https://badge.fury.io/js/ember-cli-deploy-github-deployments.svg)](https://badge.fury.io/js/ember-cli-deploy-github-deployments)
 
 ## What is an ember-cli-deploy plugin?
@@ -12,6 +11,7 @@ A plugin is an addon that can be executed as a part of the ember-cli-deploy pipe
 
 For more information on what plugins are and how they work, please refer to the [Plugin Documentation][2].
 
+
 ## Quick Start
 
 To get up and running quickly, do the following:
@@ -69,10 +69,27 @@ The user or organization that owns the reporname. e.x https://github.com/my-user
 
 The url which your assets are going to be viewed from. e.x. https://my-app-domain.com/{{commit}}
 
-## Optional Configuration Options
+## Screenshot (Pipeline)
+
+### Pending deploy
+`ember-cli-deploy-github-deployments` will set the status `pending` of the github commit on the willDeploy.
+
+![screenshot from 2017-08-20 14-08-42](https://user-images.githubusercontent.com/118861/29496839-452f279e-85b1-11e7-9ea0-0c9d608f3043.png)
+
+### Success Deploy
+`ember-cli-deploy-github-deployments` will set the status `success` of the github commit on the didDeploy.
+
+![screenshot from 2017-08-20 14-07-10](https://user-images.githubusercontent.com/118861/29496840-452fb4e8-85b1-11e7-9706-4e2f0f8d2863.png)
+
+### Error Deploy
+`ember-cli-deploy-github-deployments` will set the status `error` of the github commit on the didFail.
 
-## Note
+![screenshot from 2017-08-20 14-09-04](https://user-images.githubusercontent.com/118861/29496838-452ec646-85b1-11e7-9319-3769c06155a9.png)
 
-`ember-cli-deploy-github-deployments` will set the status of the github commit on the `didDeploy`. 
+## Roadmap
+- [ ] [Save log of deploy in Gist, when failure deploy][4]
+- [ ] [Add Github status deployments in timeline][3]
 
 [2]: http://ember-cli.github.io/ember-cli-deploy/plugins "Plugin Documentation"
+[3]: https://developer.github.com/v3/repos/deployments/
+[4]: https://developer.github.com/v3/gists/