README.rdoc in policymap_wrap-0.1.0 vs README.rdoc in policymap_wrap-0.2.0
- old
+ new
@@ -1,17 +1,17 @@
= PolicyMap Wrap
-Ruby wrapper around the PolicyMap API.
+Ruby wrapper around the PolicyMap API. Uses the YAJL library for fast JSON decoding.
== Notes
PolicyMap APIs are custom designed, so your mileage may vary depending on your API.
== Usage
Before you can perform searches, you must first setup your PolicyMap credentials:
- PolicyMap::Client.set_credentials(<account_id>)
+ PolicyMap::Client.set_credentials(<account_id>, <username>, <password>)
There are three types of searches: query, boundary and indicator.
Each search is performed as follows, respectively:
PolicyMap::Client.query_search(<search_options>)