Browse files

adding license and readme

  • Loading branch information...
1 parent 7598538 commit 6ff9821fcd8740b97ae8d0fdd1f0500f8c41bf59 @christopherhein committed Feb 16, 2012
Showing with 90 additions and 0 deletions.
  1. +20 −0 LICENSE
  2. +70 −0 README.md
View
20 LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2012 General Things Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
70 README.md
@@ -1,5 +1,75 @@
# Add This
+Ruby wrapper for the [Add This Analytics API](http://www.addthis.com/help/analytics-api#.TzzlN0zC4V).
+
+## Installation
+
+```bash
+$ gem i add_this
+```
+
+## Usage
+
+With your userid and password define a configure block that defines them like so:
+
+### Global Config
+
+```ruby
+AddThis.configure do |config|
+ config.user_id = "generalthings"
+ config.password = "awesome"
+end
+```
+
+### or Per Request
+
+```ruby
+add_this = AddThis::Client.new(user_id: "generalthings", password: "awesome")
+```
+
+For making request the api is quite simple it follows most of the current Add
+This Structure of only broken by an underscore so [/shares/day](https://api.addthis.com/analytics/1.0/pub/shares/day.csv)
+would be `shares_day`
+
+
+## Example calls
+
+You have two ways available to get data one on the AddThis class like so:
+
+```ruby
+AddThis.get.shares_day
+```
+
+or by creating the client and requesting through that like so:
+
+```ruby
+add_this = AddThis::Client.new
+add_this.shares_url
+```
+
+or passing query params you just need to provide a hash into that method as so:
+
+```ruby
+AddThis.get.shares_day({service: "facebook_like"})
+```
+
+
Resources:
* [Add This Analytics API](http://www.addthis.com/help/analytics-api#.TzzlN0zC4V)
+
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+ future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+ (if you want to have your own version, that is fine but
+ bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2012 General Things Inc. See LICENSE for details.

0 comments on commit 6ff9821

Please sign in to comment.