Skip to content

Commit

Permalink
updated readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
planetcrypton committed May 10, 2017
1 parent 5d8696f commit 8ea7579
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Let [PushBots](https://pushbots.com) push your WordPress posts
[PushBots](https://pushbots.com) is a neat, highly integratable, service to send push notifications to your app, whether it be iOS, Android or Chrome.
When WordPress is the backbone of your data, this WP plugin keeps your app's users posted. Receive push notification when a new post is published, with a customized payload.
### ToDo
* Target tags optional...
* Push when comments are made...
## Pre-Installation
Setup your app with PushBots. Make sure it works, and test your payload by using the composer on the PushBots dashboard
Expand All @@ -14,12 +13,24 @@ Setup your app with PushBots. Make sure it works, and test your payload by using
2. Activate it
3. Go to: Settings / WordPushBots
4. Enter your PushBots App-ID and -secret
5. Now configure your payload..
## Configure Payload
5. Now configure your notifications..
## Configure Push Notifications
### Notification's content
Define the alert-message:
* Post's title
* Post's content (140 chars)
* Custom text (available variables: $author, $title)
### Target
Narrow down your audience: Push notification are received by everyone..
* With pre-defined alias
* Tagged with one of post's categories (slugs)
* Tagged with one of post's tags (slugs)
* Tagged with pre-defined tags
### Payload
In your payload you can post:
* Post ID or slug
* Post's ID or slug
* Post's categories IDs or slug
* Post's tags IDs or slug
You can specify the key you're sending, for example `post_item` or `post_categories`.
You can specify the value you're sending with either ID or slug.
A result could for example become: `{ "post_item": 8343 , "post_categories": [ 25, 10, 11 ] }`
A result could for example become: `{ "post_item": 8343 , "post_categories": [ 25, 10, 11 ] }` or `{ "post_id": 8343 , "post_cats": [ "sale", "sport" ] }`

0 comments on commit 8ea7579

Please sign in to comment.