From be474296e57e88af1f38b08fc4ec3edf403f178f Mon Sep 17 00:00:00 2001 From: Ian Leitch Date: Sat, 26 Jan 2013 15:16:02 -0800 Subject: [PATCH] README updates. --- README.md | 17 ++++++++++++++++- rapns.gemspec | 4 ++-- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9599877..06e4d77 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ [![Build Status](https://secure.travis-ci.org/ileitch/rapns.png?branch=master)](http://travis-ci.org/ileitch/rapns) -### Rapns - Professional grade APNs and GCM daemon +### Rapns - Professional grade APNs and GCM for Ruby. * Supports both APNs (iOS) and GCM (Google Cloud Messaging, Android). * Seamless Rails integration. * Scalable - choose the number of threads each app spawns. * Designed for uptime - signal -HUP to add, update apps. * Stable - reconnects database and network connections when lost. +* Run as a daemon or inside an existing process. +* Use in a scheduler for low-workload deployments ([Push API](rapns/wiki/Push-API)). +* Reflection API for fine-grained instrumentation ([Reflection API](rapns/wiki/Relfection-API)). * Works with MRI, JRuby, Rubinius 1.8 and 1.9. * [Airbrake](http://airbrakeapp.com/) integration. +* Built with a love for Open Source :) #### 2.x users please read [upgrading from 2.x to 3.0](rapns/wiki/Upgrading-from-version-2.x-to-3.0) @@ -91,9 +95,17 @@ n.save! ## Starting Rapns +As a daemon: + cd /path/to/rails/app rapns [options] +Inside an existing process: + + Rapns.embed + +*Please note that only ever a single instance of Rapns should be running.* + See [Configuration](rapns/wiki/Configuration) for a list of options, or run `rapns --help`. ## Updating Rapns @@ -107,6 +119,9 @@ After updating you should run `rails g rapns` to check for any new migrations. * [Upgrading from 2.x to 3.0](rapns/wiki/Upgrading-from-version-2.x-to-3.0) * [Deploying to Heroku](rapns/wiki/Heroku) * [Hot App Updates](rapns/wiki/Hot-App-Updates) +* [Reflection API](rapns/wiki/Reflection-API) +* [Push API](rapns/wiki/Push-API) +* [Embedding API](rapns/wiki/Embedding-API) ### APNs * [Advanced APNs Features](rapns/wiki/Advanced-APNs-Features) diff --git a/rapns.gemspec b/rapns.gemspec index 25d0a09..8fb6911 100644 --- a/rapns.gemspec +++ b/rapns.gemspec @@ -8,8 +8,8 @@ Gem::Specification.new do |s| s.authors = ["Ian Leitch"] s.email = ["port001@gmail.com"] s.homepage = "https://github.com/ileitch/rapns" - s.summary = %q{Professional grade APNs and GCM daemon} - s.description = %q{Professional grade APNs and GCM daemon} + s.summary = %q{Professional grade APNs and GCM for Ruby} + s.description = %q{Professional grade APNs and GCM for Ruby} s.files = `git ls-files -- lib README.md CHANGELOG.md LICENSE`.split("\n") s.test_files = `git ls-files -- {test,spec,features,config}`.split("\n")