Permalink
Browse files

Update readme with usage examples

  • Loading branch information...
1 parent e435a2c commit 50b3cd36db68b6287662a13e1910e94fea5cb2ab @shayfrendt shayfrendt committed Feb 15, 2012
Showing with 24 additions and 1 deletion.
  1. +24 −1 README.md
View
@@ -4,7 +4,30 @@ StatRaptor API wrapper for Ruby [![build status](https://secure.travis-ci.org/ch
Interact with client like so:
``` ruby
-TODO
+# Configure the library to use your
+# StatRaptor platform credentials
+
+StatRaptor.configure do |config|
+ config.platform_credentials = "ABC123"
+end
+
+# Initialize a client
+client = StatRaptor::Client.new
+
+# Manage users
+client.create_user(:email => "timmy@example.com", :chargify_api_key => "XYZ456")
+client.delete_user("akskd8328389281728918")
+
+# Manage projects
+client.create_project(:user_credentials => "3892839akslje",
+ :project => {:name => "Zippy", :subdomain => "zippy-llc", :component => "advanced"})
+client.delete_project(:user_credentials => "3892839akslje", :subdomain => "zippy-llc")
+
+# Graphs
+client.get_revenue_graph_data(:user_credentials => "3892839akslje", :subdomain => "zippy-llc")
+client.get_subscribers_graph_data(:user_credentials => "3892839akslje", :subdomain => "zippy-llc")
+client.get_average_lifetime_value_graph_data(:user_credentials => "3892839akslje", :subdomain => "zippy-llc")
+client.get_churn_graph_data(:user_credentials => "3892839akslje", :subdomain => "zippy-llc")
```
### Installation

0 comments on commit 50b3cd3

Please sign in to comment.