README.md in statsmix-0.1.10 vs README.md in statsmix-0.2.1
- old
+ new
@@ -1,22 +1,24 @@
-A Ruby gem for the StatsMix API - http://www.statsmix.com/developers
+A Ruby gem for the StatsMix API - [http://www.statsmix.com/developers](http://www.statsmix.com/developers)
## What is StatsMix?
StatsMix makes it easy to track, chart, and share application and business metrics. Use StatsMix to:
* Log every time a particular event happens (such as a user creating a new blog post)
* View a real-time chart of these application events in StatsMix's web UI
* Share the charts with users inside and outside your organization
* Create and share custom dashboards that aggregate multiple metrics together
- * Example dashboard: http://www.statsmix.com/d/0e788d59208900e7e3bc
- * Example embedded dashboard: http://www.statsmix.com/example-embedded
+ * Example dashboard: [http://www.statsmix.com/d/0e788d59208900e7e3bc](http://www.statsmix.com/d/0e788d59208900e7e3bc)
+ * Example embedded dashboard: [http://www.statsmix.com/example-embedded](http://www.statsmix.com/example-embedded)
-To get started, you'll need an API key for StatsMix. You can get a free developer account here: http://www.statsmix.com/try?plan=developer
+To get started, you'll need an API key for StatsMix. You can get a free developer account here: [http://www.statsmix.com/try?plan=developer](http://www.statsmix.com/try?plan=developer)
-Full gem documentation is at http://www.statsmix.com/developers/ruby_gem
+Full gem documentation is at [http://www.statsmix.com/developers/ruby_gem](http://www.statsmix.com/developers/ruby_gem)
+Partner API documentation is at [http://www.statsmix.com/developers/partner_api](http://www.statsmix.com/developers/partner_api)
+
## Quick Start
Install the gem from the command line.
gem install statsmix
@@ -55,10 +57,22 @@
StatsMix.test_metric_name = "My Test Metric"
## More Documentation
-The StatsMix gem supports all the methods documented at http://www.statsmix.com/developers/documentation
+The StatsMix gem supports all the methods documented at [http://www.statsmix.com/developers/documentation](http://www.statsmix.com/developers/documentation)
+
+## Partner API
+We recently added ALPHA-LEVEL support for our Partner API, which allows you to provision users and metrics in StatsMix. The methods are:
+
+
+ StatsMix.create_user({})
+ StatsMix.update_user(id,{})
+ StatsMix.delete_user(id)
+
+In all cases, the affected user's api key will be available via `StatsMix.user_api_key`. You can use the api key for updating and deleting users as well. In other words, __there is no need to store another identifier besides the user's api key.__
+
+Full Partner API documentation is at [http://www.statsmix.com/developers/partner_api](http://www.statsmix.com/developers/partner_api)
## Contributing to statsmix
* 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
\ No newline at end of file