-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
6 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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### | ||
|
@@ -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', | ||
|
@@ -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]' }) | ||
|