Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
ChimeraCoder committed Mar 4, 2013
1 parent 9ee8cfd commit 710d092
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Anaconda
====================


Anaconda is a Go package to access version 1.1 of the Twitter API.



Examples
-------------

````go
twitter.SetConsumerKey("your-consumer-key")
twitter.SetConsumerSecret("your-consumer-secret")
api := twitter.NewTwitterApi("your-access-token", "your-access-token-secret")
searchResult, _ := api.GetSearch("golang", url.Values{})
for _ , tweet := range searchResult {
fmt.Print(tweet.Text)
}
````



Endpoints
------------

Anaconda implements most of the endpoints defined in the [Twitter API documentation](https://dev.twitter.com/docs/api/1.1). For clarity, in most cases, the function name is simply the name of the HTTP method and the endpoint (e.g., the endpoint `GET /friendships/incoming` is provided by the function `GetFriendshipsIncoming`).

In a few cases, a shortened form has been chosen to make life easier (for example, retweeting is simply the function `Retweet`)



License
-----------
Anaconda is free software licensed under the MIT/X11 license. Details provided in the LICENSE file.
1 change: 1 addition & 0 deletions README.md

0 comments on commit 710d092

Please sign in to comment.