Skip to content

update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions README → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
This is a Java client for the Twitter streaming API, documented at
# This is a Java client for the Twitter streaming API, documented at

http://apiwiki.twitter.com/Streaming-API-Documentation
![alt text](https://help.twitter.com/content/dam/help-twitter/twitter_logo_blue.png)

Source is available at
See [Streaming API Documentation](http://apiwiki.twitter.com/Streaming-API-Documentation)

http://github.com/gistinc/TwitterClient
## Source is available at
[Github](http://github.com/gistinc/TwitterClient)

### Description
com.gist.twitter.TwitterClient connects to Twitter using the Jakarta
Commons HttpClient 3.1, http://hc.apache.org/httpclient-3.x/. It
backs off and reconnects on HTTP and TCP errors as per the spec. It
can connect using multiple sets of credentials at once.
Commons HttpClient 3.1, [official doc](http://hc.apache.org/httpclient-3.x/) .
It backs off and reconnects on HTTP and TCP errors as per the spec.
It can connect using multiple sets of credentials at once.

TwitterClient is constructed with two helper objects. This
functionality has been factored out since it's likely to vary wildly
according to need.

- A FilterParameterFetcher is called periodically to get the set of
Twitter ids to follow and keywords to track.

- A TwitterStreamProcessor processes the actual data stream. How this
is done and how you filter and process the results are up to you.
Twitter recommends handing off statuses via an asynchronous queueing
Expand All @@ -28,4 +29,4 @@ according to need.
The example code provides rudimentary implementations of both of these
objects. It will connect with the given credentials, track a given
set of Twitter ids, parse the JSON, and print it to stdout.
Essentially this just replicates the stream to stdout.
Essentially this just replicates the stream to stdout.