README.md in rest-gw2-0.1.0 vs README.md in rest-gw2-0.2.0
- old
+ new
@@ -23,36 +23,63 @@
## REQUIREMENTS:
* Tested with MRI (official CRuby), Rubinius and JRuby.
* rest-core
-* jellyfish (only for web application)
+### REQUIREMENTS: (if you need the web application)
+
+* rack
+* jellyfish
+* dalli (optional for memcached)
+* lru_redux (optional for LRU cache)
+
## INSTALLATION:
gem install rest-gw2
+## INSTALLATION: (if you need the web application)
+
+ gem install rest-gw2 rack jellyfish
+ gem install dalli # if you have memcached
+ gem install lru_redux # if you don't have memcached
+ gem install puma # for a faster server which also works for JRuby
+ gem install yahns rack-handlers # slightly faster than puma, CRuby only
+
## SYNOPSIS:
``` ruby
require 'rest-gw2'
gw2 = RestGW2::Client.new(:access_token => '...')
gw2.get('account/bank') # => list of items in your bank
```
-## Bundled Web Application:
+## SYNOPSIS: (if you need the web application)
If you would like to try it, run with:
- env ACCESS_TOKEN=... rest-gw2-server
+ env RESTGW2_SECRET=... rest-gw2
-Or you could put your access token in a config file and point it with:
+The secret would be used for encrypting the access token. If you don't
+set it then it would just use the default secret, which basically means
+no encrypting at all, because the default secret is hard coded in the
+source, which is publicly available because this is an open source project.
- env RESTGW2_CONFIG=... rest-gw2-server
+Or you could put your secret in a config file and point it with:
+ env RESTGW2_CONFIG=... rest-gw2
+
The format for the config file would be like:
- ACCESS_TOKEN=...
+ RESTGW2_SECRET=...
+ RESTGW2_PREFIX=...
+
+## DVELOPMENT:
+
+ git clone git@github.com:godfat/rest-gw2.git
+ cd rest-gw2
+ gem install rack jellyfish lru_redux yahns rack-handlers
+ ruby -Ilib:rest-core/lib -S bin/rest-gw2
## CONTRIBUTORS:
* Lin Jen-Shin (@godfat)