Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
msaint committed Aug 16, 2013
1 parent d8fe819 commit 07fe387
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ For the latest information on this project, take a look at:

###Including the gem in your Gemfile###

gem 'crowdtilt', :github => 'msaint/crowdtilt'
gem 'crowdtilt'


###Initializing the client###
Your api_key / api_secret is required to initialize the client. Please email [[email protected]](mailto: [email protected]) to request credentials.

You should specify with the `mode` parameter whether you are attempting to access the `sandbox` API or the `production` API.

Crowdtilt.configure :api_key => YOUR_API_KEY,
:api_secret => YOUR_API_SECRET,
Crowdtilt.configure :api_key => YOUR_API_KEY,
:api_secret => YOUR_API_SECRET,
:mode => API_MODE # 'sandbox' or 'production'

###API methods###
Expand All @@ -32,7 +32,7 @@ Errors returned by the API will be raised as exceptions.
**Examples:**

Create a user:

user = Crowdtilt.create_user({
:firstname => 'John',
:lastname => 'Smith',
Expand All @@ -42,11 +42,11 @@ Create a user:
Get a list of users:

users = Crowdtilt.get_users

Get a specific of user:

user = Crowdtilt.get_user('USR123')

Update a user:

user = Crowdtilt.update_user('USR123', { :email => '[email protected]' })
Expand Down

0 comments on commit 07fe387

Please sign in to comment.