-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathREADME
72 lines (54 loc) · 3.12 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# TweetNET v1.1
by Zachary Kniebel
## Overview
TweetNET is a C# library for accessing the new Twitter API, v1.1. It is
light-weight, highly extensible, and includes classes designed for
explicit use with the different requests supported by twitter (e.g.
GET statuses/user_timeline, GET statuses/show/:id, etc.). The library
also satisfies the oAuth requirements for authorizing requests to
Twitter. The library matches up with Twitter's API, exactly, and all
request specific classes include, as properties, all of the query
parameters accepted by Twitter, for that request. The library's
intellisense for these properties is also copied directly from
Twitter's description and example values for that parameter, in their
API.
## Using the Library
The initial release has included classes for two of Twitter's requests,
GET statuses/user_timeline and GET statuses/show/:id, (more are on the
way) along with the base Request class, which can be used to make any
request to Twitter. If you wish to use the Request class directly, you
will have to look up the request parameters that you need/want in the
request at http://dev.twitter.com/. You may also inherit the Request
class to build onto the library, using the inheriting classes for
the implemented request types as a guide. Please remember that v1.0 is
still in alpha testing. Namespace and class-name changes may occur
between v1.0 and v1.1 (beta), which is targeted for Wednesday, April
3rd, 2013. All namespace and class-name changes will be documented and
noted in the commit logs, for each class that they effect.
## Making a request
Please view the Example_Request.txt document, for an example of how
you can make a simple request to retrieve a user's timeline. Note that
the Library matches up with Twitter's API, and request-specific classes
include, as properties, all of the query parameters accepted by
Twitter.
## Documentation
Click [here](https://rawgithub.com/zkniebel/TweetNet/master/TweetNET/docs/Help/Index.html) to view the API documentation for the library, online.
To view the documentation for this library after download, go to
*TweetNET -> docs -> Help* and open the file "index.html" in either IE
or FireFox.
## Rendering Tweets
TweetNET was originally designed to provide a C# back-end for Twitter
Feed, a jQuery plugin that is designed to simplify the rendering of
tweets. It was developed with simplicity, robustness, and performance
in mind, and may be used to render tweets regardless of the type of
request that was used to retrieve them. For more information, view the
repository at https://github.com/zkniebel/jquery-twitter-feed.
## Version and Release Notes
-- Merged v1.1.0 into master --
v1.1.0 (beta) April 2, 2013
- Refactored and reorganized namespace to better match Twitter's API
- Added statuses/filter and search/tweets
- Added library documentation
- First four requests alpha test-complete
-- Created Branch: v1.1 (beta) - April 2, 2013 --
-- Created Branch (backup): v1.0 (alpha) - April 1st, 2013 --