README.md in spns-0.2.2 vs README.md in spns-0.2.4
- old
+ new
@@ -1,21 +1,36 @@
spns
=======
Simple Push Notification Server written with Sinatra and Sequel(Sqlite3)
+Feature:
+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.
+
Prerequisites
=======
+
Ruby
-------
spns is a ruby gem, require ruby installed on your mac machine. Since now all Mac OSX system preinstalled ruby enviroment, that's not a big issue.
Rubygem(latest)
-------
spns require latest rubygem installed, so you need to update your rubygem to latest version, run command below to update your rubygem to the latest one.
$ sudo gem update --system # double dash option
+
+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
+
Installation
=======
$ sudo gem install spns
@@ -27,10 +42,10 @@
3. provide a cron script under current directory, default named "cron" according to spns.yml
4. start spns server, default port is 4567(sinatra's default port)
- $ spns
+
== Contributing to spns
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.