From f8c8cd4467a02944ba9e5f687ab61330636f3e9f Mon Sep 17 00:00:00 2001 From: Adam Wynne Date: Mon, 27 Jun 2011 15:59:35 +0100 Subject: [PATCH] now a markdown --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6044cfb --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# twitter-client + +This is an up-to-date twitter API wrapper that is based on the clojure async.http.client library. It offers the full taxonomy of twitter API's (streaming, search and restful) and has been tested to be working. There are some tests included, but it is far from complete and needs to be made exhaustive. + +## Usage + +The calls are declared with numerous macros that allow all sorts of fanciness. Note that unlike other API's, the parameters for each call are note hard-coding into their Clojure wrappers. I just figured that you could look them up on the dev.twitter.com and supply them in the :params map that is supplied. + +`(show-user :oauth-creds ) + +## License + +Copyright (C) 2011 Adam Wynne + +Distributed under the Eclipse Public License, the same as Clojure.