Restore README.md, rename the old README as INSTALL

farcepest · farcepest · commit 36b8d1d4e8b5 · 2012-10-04T13:43:11.000-04:00
diff --git a/INSTALL b/INSTALL
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -2,6 +2,8 @@ recursive-include doc *.txt
 recursive-include tests *.py
 include MANIFEST.in
 include HISTORY
+include INSTALL
+include README.md
 include GPL-2.0
 include pymemcompat.h
 include metadata.cfg
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+MySQLdb1
+========
+
+This is the legacy (1.x) version of MySQLdb. While it is still being
+maintained, there will not be a lot of new feature development. 
+
+[![Build Status](https://secure.travis-ci.org/farcepest/MySQLdb1.png)](http://travis-ci.org/farcepest/MySQLdb1)
+
+TODO
+----
+
+* A bugfix 1.2.4 release
+* A 1.3.0 release that will support Python 2.7-3.3
+* The 2.0 version is being renamed [moist][] and is heavily refactored.
+
+Projects
+--------
+
+* [MySQLdb-svn][]
+
+	This is the old Subversion repository located on SourceForge.
+	It has all the early historical development of MySQLdb through 1.2.3,
+	and also is the working repository for ZMySQLDA. The trunk on this
+	repository was forked to create the [MySQLdb2][] repository.
+
+* [MySQLdb1][]
+
+	This is the new (active) git repository.
+	Only updates to the 1.x series will happen here.
+
+* [MySQLdb2][]
+
+	This is the now obsolete Mercurial repository for MySQLdb-2.0
+	located on SourceForge. This repository has been migrated to the
+    [moist][] repository.
+
+
+[MySQLdb1]: https://github.com/farcepest/MySQLdb1
+[moist]: https://github.com/farcepest/moist
+[MySQLdb-svn]: https://sourceforge.net/p/mysql-python/svn/
+[MySQLdb2]: https://sourceforge.net/p/mysql-python/mysqldb-2/
