New README.
authorJoshua Roesslein <jroesslein@gmail.com>
Thu, 8 Nov 2012 03:35:43 +0000 (19:35 -0800)
committerJoshua Roesslein <jroesslein@gmail.com>
Thu, 8 Nov 2012 03:35:43 +0000 (19:35 -0800)
ASCII_LOGO.txt [new file with mode: 0644]
README [deleted file]
README.md [new file with mode: 0644]

diff --git a/ASCII_LOGO.txt b/ASCII_LOGO.txt
new file mode 100644 (file)
index 0000000..55cc5d5
--- /dev/null
@@ -0,0 +1,7 @@
+  ______                                   
+ /_  __/_      __ ___   ___   ____   __  __
+  / /  | | /| / // _ \ / _ \ / __ \ / / / /
+ / /   | |/ |/ //  __//  __// /_/ // /_/ / 
+/_/    |__/|__/ \___/ \___// .___/ \__, /  
+                          /_/     /____/ 
+
diff --git a/README b/README
deleted file mode 100644 (file)
index 9351d6d..0000000
--- a/README
+++ /dev/null
@@ -1,22 +0,0 @@
-  ______                                   
- /_  __/_      __ ___   ___   ____   __  __
-  / /  | | /| / // _ \ / _ \ / __ \ / / / /
- / /   | |/ |/ //  __//  __// /_/ // /_/ / 
-/_/    |__/|__/ \___/ \___// .___/ \__, /  
-                          /_/     /____/ 
-
-A Python library for accessing the Twitter API.
-
-Requires Python 2.5 or later. Sorry no Python 3 support yet.
-
-Website: http://tweepy.github.com/
-Git Repository: http://github.com/tweepy/tweepy.git
-Google Groups: http://groups.google.com/group/tweepy
-IRC Channel: freenode.net #tweepy
-
-How to contribute a patch:
-  1. Fork Tweepy on github.com
-  2. Create a new branch
-  3. Commit changes to this branch
-  4. Send a pull request
-
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..6f2dffe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+Tweepy [![Build Status](https://travis-ci.org/tweepy/tweepy.png)](https://travis-ci.org/tweepy/tweepy)
+======
+A Python library for accessing the Twitter API.
+
+Installation
+------------
+The easiest way to install the latest version
+is by using pip/easy_install to pull it from PyPI:
+
+    pip install tweepy
+
+You may also use Git to clone the repository from
+Github and install it manually:
+
+    git clone https://github.com/tweepy/tweepy.git
+    python setup.py install
+
+**Note** only Python 2.5 to 2.7 is supported at
+the moment. The Python 3 family is not yet supported.
+
+Documentation
+-------------
+  - [Website (Work in-progress)](http://tweepy.github.com/)
+  - [Twitter Developers](http://dev.twitter.com/)
+
+Community
+---------
+  - [Google Group/Mailing list](http://groups.google.com/group/tweepy)
+  - IRC Chat (Freenode.net #tweepy)
+