Skip to content
This repository has been archived by the owner on Nov 28, 2017. It is now read-only.

Commit

Permalink
Simple example in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ilya Chekalskiy committed May 8, 2015
1 parent 426ed9d commit 8ad9786
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,23 @@
Simple library to track App Store reviews with Slack.

>[Slack](https://slack.com/) is a platform for team communication
### Installing via Composer
```bash
composer.phar require tjournal/reviewer:~0.1
```

After installing, you need to require Composer's autoloader:

```php
require 'vendor/autoload.php';
```

### Simple usage
To track reviews just [create new Incoming webhook](https://slack.com/services/new/incoming-webhook) in Slack and add this code to crontab (once per hour):

```php
$reviewer = new TJ\Reviewer(683103523);
$reviewer->setSlackSettings(['endpoint' => 'https://hooks.slack.com/services/ABCDE/QWERTY', 'channel' => '#reviews'])
$reviewer->work();
```

0 comments on commit 8ad9786

Please sign in to comment.