From 8ea7579e0d84c8e14d0b795f210114e93885177f Mon Sep 17 00:00:00 2001 From: Sjoerd Kok Date: Wed, 10 May 2017 11:54:41 +0200 Subject: [PATCH] updated readme file --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a6bbae2..10ee9c1 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 ] }` \ No newline at end of file +A result could for example become: `{ "post_item": 8343 , "post_categories": [ 25, 10, 11 ] }` or `{ "post_id": 8343 , "post_cats": [ "sale", "sport" ] }` \ No newline at end of file