README.md in spns-0.2.7 vs README.md in spns-0.2.8

- old
+ new

@@ -1,39 +1,55 @@ spns ======= Simple Push Notification Server written with Sinatra and Sequel(Sqlite3) Feature: -* rubygem, simple to install. -* provide pem file is the only requirement. -* no need to setup database, using sqlite3. -* provide default config file(spns.yml) with default value. +======= +1. rubygem, simple to install. +2. provide pem file is the only requirement. +3. no need to setup database, using sqlite3. +4. provide default config file(spns.yml) with default value. + Requirement - +======= + Sqlite3 ------- -* CentOS/Redhat: yum install sqlite3 -* Debian/Ubuntu: apt-get install sqlite3 -* FreeBSD: $ cd /usr/ports/databases/sqlite34 $ sudo make install clean -* Mac: Homebrew: brew install sqlite3 Port: port install sqlite3 +CentOS/Redhat: + $ yum install sqlite3 + +Debian/Ubuntu: + + $ apt-get install sqlite3 + +FreeBSD: + + $ cd /usr/ports/databases/sqlite34 + $ sudo make install clean + +Mac: + + $ brew install sqlite3 # Homebrew + $ port install sqlite3 # Macport + Installation ======= $ sudo gem install spns Usage ======= -* under the current directory, provide single pem file combined with certificate and key, HOWTO ([Check this link](http://www.raywenderlich.com/3443/apple-push-notification-services-tutorial-part-12)) +1. under the current directory, provide single pem file combined with certificate and key, HOWTO ([Check this link](http://www.raywenderlich.com/3443/apple-push-notification-services-tutorial-part-12)) -* edit spns.yml. (when you run spns first time, it will generate this file) ([Check this link](https://raw.github.com/eiffelqiu/spns/master/spns.yml)) +2. edit spns.yml. (when you run spns first time, it will generate this file) ([Check this link](https://raw.github.com/eiffelqiu/spns/master/spns.yml)) -* provide a cron script under current directory, default named "cron" according to spns.yml +3. provide a cron script under current directory, default named "cron" according to spns.yml -* start spns server, default port is 4567(sinatra's default port) +4. start spns server, default port is 4567(sinatra's default port) ![spns usage](https://raw.github.com/eiffelqiu/spns/master/doc/capture1.png) Contributing to spns ======= @@ -45,9 +61,9 @@ * Commit and push until you are happy with your contribution. * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally. * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it. Copyright -== +======= Copyright (c) 2012 Eiffel Qiu. See LICENSE.txt for further details.