diff --git a/README.md b/README.md index 1ca425d..00085b3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The GCM gem lets your ruby backend send notifications to Android and iOS devices via [ Google Cloud Messaging](https://developers.google.com/cloud-messaging/gcm). -##Installation +## Installation $ gem install gcm @@ -14,7 +14,7 @@ or in your `Gemfile` just include it: gem 'gcm' ``` -##Requirements +## Requirements An Android device running 2.3 (or newer) or an iOS device and an API key as per [GCM getting started guide](https://developers.google.com/cloud-messaging/android/start). @@ -25,7 +25,7 @@ One of the following, tested Ruby versions: * `2.2.4` * `2.3.0` -##Usage +## Usage For your server to send a message to one or more devices, you must first initialise a new `GCM` class with your Api key, and then call the `send` method on this and give it 1 or more (up to 1000) registration tokens as an array of strings. You can also optionally send further [HTTP message parameters](https://developers.google.com/cloud-messaging/http-server-ref) like `data` or `time_to_live` etc. as a hash via the second optional argument to `send`. @@ -144,11 +144,11 @@ The guide to set up an iOS app to get notifications is here: [Setting up a GCM C * Only support Ruby versions [>= 1.9.3](https://www.ruby-lang.org/en/news/2014/01/10/ruby-1-9-3-will-end-on-2015/) * Fixed Rspec deprecation warnings for Rspec 3.0.0.beta -##MIT License +## MIT License * Copyright (c) 2016 Kashif Rasul and Shoaib Burq. See LICENSE.txt for details. -##Many thanks to all the contributors +## Many thanks to all the contributors * [Contributors](https://github.com/spacialdb/gcm/contributors)