README.md in pushpad-0.1.6 vs README.md in pushpad-0.2.1
- old
+ new
@@ -1,21 +1,21 @@
-# Pushpad: web push notifications
+# Pushpad: real push notifications for websites
-Add web push notifications to your web app using third-party service [Pushpad](https://pushpad.xyz).
+Add native push notifications to your web app using [Pushpad](https://pushpad.xyz).
+Features:
+
+- notifications are delivered even when the user is not on your website
+- users don't need to install any app or plugin
+- you can target specific users or send bulk notifications
+
Currently push notifications work on the following browsers:
- Chrome (Desktop and Android)
- Firefox (44+)
- Safari
-Features:
-
-- users don't need to install any app or plugin
-- notifications are delivered even when the user is not on your website
-- you can target specific users or send bulk notifications
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -28,24 +28,38 @@
Or install it yourself as:
$ gem install pushpad
-## Usage
+## Getting started
-First you need to sign up to Pushpad and create a project there. It takes 1 minute.
+First you need to sign up to Pushpad and create a project there.
Then set your authentication credentials:
-```
+```ruby
Pushpad.auth_token = '5374d7dfeffa2eb49965624ba7596a09'
Pushpad.project_id = 123 # set it here or pass it as a param to methods later
```
`auth_token` can be found in the user account settings.
`project_id` can be found in the project settings on Pushpad. A project is a list of subscriptions. You can set it globally or pass it as a param to methods if your app uses multiple lists (e.g. `Pushpad.path_for current_user, project_id: 123`, `notification.deliver_to user, project_id: 123`).
+## Collecting user subscriptions
+
+### Custom API
+
+Read the [docs](https://pushpad.xyz/docs#custom_api_docs).
+
+If you need to generate the HMAC signature for the `uid` you can use this helper:
+
+```ruby
+Pushpad.signature_for current_user.id
+```
+
+### Simple API
+
Let users subscribe to your push notifications:
```erb
<a href="<%= Pushpad.path %>">Subscribe anonymous to push notifications</a>
@@ -54,10 +68,12 @@
`current_user` is the user currently logged in on your website.
When a user clicks the link is sent to Pushpad, automatically asked to receive push notifications and redirected back to your website.
-Then you can send notifications:
+## Sending notifications
+
+After you have collected the user subscriptions you can send them push notifications:
```ruby
notification = Pushpad::Notification.new({
body: "Hello world!",
title: "Website Name", # optional, defaults to your project name