README.md in tutter-0.0.1 vs README.md in tutter-0.0.2
- old
+ new
@@ -1,6 +1,8 @@
# Tutter - Plugin based Github robot
+[](https://travis-ci.org/JHaals/tutter)
+
Tutter is a web app that trigger actions based on Github events(push, pull_reqeust, release, issue, ...)
# Features
* Pluggable with custom actions
* Supports multiple projects
@@ -21,39 +23,36 @@
* `github_site` - github website
* `github_api_enpoint` - github api endpint
* `action` - action you wish to use for the project
* `action_settings` - whatever settings your action require
-### Create the Github hook
-Github has no UI for creating hooks other then hooks triggered on push.
+### Create the Github webhook
+Hooks can be configured just to send the event that you're interested in. The important part is that `Payload URL` points to the webserver running tutter
-Let's create one that triggers on issues
+ https://github.com/ORG/PROJECT/settings/hooks/new
- $ tutter --project jhaals/testing \
- --url https://tutter.jhaals.se \
- --access-token <github_api_token> \
- --github-web-url https://github.com \
- --github-api-endpoint https://api.github.com \
- --events issues
+Example of how the `thanks` demo-action look like. Tutter listen for issue events and posts back with a greeting.
+
## Build custom action
-Another example action [github.com/jhaals/tutter-sppuppet](https://github.com/jhaals/tutter-sppuppet)
+See [thanks action](https://github.com/jhaals/tutter/blob/master/lib/tutter/action/thanks.rb)
#####Required methods and their arguments
`initialize`
settings - contains a hash of action specific settings
client - Used to access the github api, all authentication is already done by tutter
project - Project name, eg jhaals/tutter
+ event - Event type
data - POST data that github send when a hook is triggered
`run` - Run action
Tutter uses [octokit.rb](https://github.com/octokit/octokit.rb) to communicate with the Github [API](http://developer.github.com/v3/)
### Features to implement
-* Add web hooks in Github automatically
* Support multiple actions per project
* Authenticate as a Github application
-* Features your're missing (please contribute)
\ No newline at end of file
+* Features your're missing (please contribute)
+* Tests!