README.md in reviewlette-0.0.9 vs README.md in reviewlette-1.0.0
- old
+ new
@@ -1,43 +1,43 @@
-Reviewlette
-===========
+[](https://codeclimate.com/github/SUSE/reviewlette)
+[](https://travis-ci.org/SUSE/reviewlette)
-[](https://coveralls.io/r/jschmid1/reviewlette)
-[](https://codeclimate.com/github/jschmid1/reviewlette)
+# Reviewlette
+Tool to automatically assign reviewers to GitHub pull requests and to move and comment on their Trello cards.
-Tool to automatically assign a "Reviewer" to a GitHub Issue and to the attached Trello Card.
-
-
What it does:
-- Finds unassigned issues on GitHub.
-- Assigns a member of your team.
-- Locates the right Card on Trello.
-- Checks if the assignee is on vacation(using tel).
-- Adds the assigned member to the Card.
-- Move the card to 'In review'
+- Finds pull requests with missing reviewers in your GitHub repos.
+- Assigns random members of your team.
+- Locates the right card in your Trello board.
+- Mentions the assigned reviewer in a comment on the card.
+- Moves the card to the 'In review' column.
-
## Installation
+For the latest and greatest version you should `git clone https://github.com/SUSE/reviewlette`
+## Usage
+```ruby
+Reviewlette.new(members: User.all, github_config: {}, trello_config: {}).run
```
-gem install reviewlette
-reviewlette
-```
+Users must respond to `trello_handle` and `github_handle` methods.
-## Setup
+Examples for `github_config` and `trello_config` can be found in `config/`.
-#### Name your pullrequest like so:
-#### Review_#23_name_of_review_42 <= trello card number
+### Matching Trello cards
+To match a Trello card to a pull request, its title has to end with the card number (not the id)
-Fill `config/.trello.yml` (instructions in the file)
-Fill `config/.github.yml` (instructions in the file
+#### Example:
+URL of the Trello card: _https://trello.com/c/cardid/4242-fix-everything_
----
+Pull request title should be: `Fix almost everything 4242`
-[Using Octokit as a GitHub api wrapper](https://github.com/octokit/octokit.rb)
-[Using ruby-trello as a Trello api wrapper](https://github.com/jeremytregunna/ruby-trello)
+__Note:__ Pull requests without a matching Trello card get skipped and won't be assigned to a reviewer.
+### Labels
+You can tweak Reviewlette's behavior by adding special labels to your pull request:
-
+| Label | Description |
+|-------------|----------------------|
+| 2 reviewers | Assign two reviewers |