diff --git a/Overview-(Intro).textile b/Overview-(Intro).textile new file mode 100644 index 0000000..53b1368 --- /dev/null +++ b/Overview-(Intro).textile @@ -0,0 +1,23 @@ +h1. Tango Documentation + +Tango covers Twitter's API in (what is hopefully) full. It should be fairly self explanatory; documentation is split up in parts relating to each set of functions. Tango's API documentation tries to mirror "Twitter's API documentation":http://apiwiki.twitter.com/Twitter-API-Documentation in some manner. With that said, before using Tango, it's worth reading through Twitters "guide on things every Twitter developer should know":http://apiwiki.twitter.com/Things-Every-Developer-Should-Know. + +h1. The basics of using Tango + +Tango was designed to be quick and easy to use. Before you can use any of the API methods, though, you need to create an instance of Tango. When creating an instance of Tango to reference, there's a few things worth noting. You can choose to instantiate Tango with no Authentication, OAuth-based Authentication, or Basic (HTTP) Authentication. There's also an extra debug parameter that you can pass, which will provide header information on failed requests. + +
+
+import tango
+
+# Using no authentication and specifying Debug
+twitter = tango.setup(debug=True)
+
+# Using Basic Authentication
+twitter = tango.setup(authtype="Basic", username="example", password="example")
+
+# Using OAuth Authentication (Note: OAuth is the default, specify Basic if needed)
+auth_keys = {"consumer_key": "yourconsumerkey", "consumer_secret": "yourconsumersecret"}
+twitter = tango.setup(username="example", password="example", oauth_keys=auth_keys)
+
+
\ No newline at end of file