Skip to content

Commit

Permalink
Update readme for Google Play apps
Browse files Browse the repository at this point in the history
No longer necessary to provide app information manually for Google Play apps.
  • Loading branch information
wahni committed Jan 31, 2018
1 parent b9cf90f commit 10de7d7
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,18 @@ for (var i = 0; i < apps.length; i++) {

## start(options) -- Available options

- `slackHook`: Mandatory, URL to an incoming Slack webhook
- `appId`: Mandatory, ID of an app in App Store or Google Play, e.g. `123456789` or `com.my.app`
- `region`: Two-letter country code for App Store (e.g. `us`), or two-letter language code for Google Play (e.g. `en`)
- `slackHook`: Mandatory, URL to an incoming Slack webhook.
- `appId`: Mandatory, ID of an app in App Store or Google Play, e.g. `123456789` or `com.my.app`.
- `region`: Two-letter country code for App Store (e.g. `us`), or two-letter language code for Google Play (e.g. `en`).
- `interval`: How often the feed should be queried, in seconds. **Default**: `300`
- `debug`: Set to `true` to log debug information and send welcome message to Slack. **Default**: `false`
- `channel`: Which channel to post to, set to override channel set in Slack
- `channel`: Which channel to post to, set to override channel set in Slack.
- `store`: To explicitly set the store, `app-store` or `google-play`. In most cases desired store can be derived from the appId so setting this is usually not required.
- `botUsername`: Set to override the default bot username set in Slack
- `botIcon`: Set to override the default bot icon set in Slack
- `appName`: Set to override the app name fetched from the feed (name is currently not fetched automatically from Google Play)
- `appIcon`: Set to override the app icon fetched from the feed (icon is currently not fetched automatically from Google Play)
- `appLink`: Set to override the app link fetched from the feed (link is currently not fetched automatically from Google Play)
- `botUsername`: Set to override the default bot username set in Slack.
- `botIcon`: Set to override the default bot icon set in Slack.
- `appName`: Set to override the app name fetched from the feed.
- `appIcon`: Set to override the app icon fetched from the feed.
- `appLink`: Set to override the app link fetched from the feed.

## License
[MIT](LICENSE)

0 comments on commit 10de7d7

Please sign in to comment.