From c957e49b26cde0f8ddca589af69e192229619f81 Mon Sep 17 00:00:00 2001
From: "jan.dittberner" <unknown>
Date: Sun, 25 Jan 2009 10:53:32 +0000
Subject: [PATCH] updated project documentation

---
 CHANGELOG | 20 +++++++++++---------
 README    | 36 ++++++++++++++++++++++++++++--------
 TODO      |  3 +++
 3 files changed, 42 insertions(+), 17 deletions(-)
 create mode 100644 TODO

diff --git a/CHANGELOG b/CHANGELOG
index c69dc7a..1b5ec82 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,13 +1,15 @@
 0.5.0
-- SA 0.5.x support.
-- py.test is no longer used for testing.  (use nose)
-- Added --echo=True option for all commands, which will make the sqlalchemy connection echo SQL statements.
-- Better Postgres support, especially for schemas.
-- modification to the downgrade command to simplify the calling (old way still works just fine)
-- TODO: complete MySQL support
-
-0.4.x
-- TODO: document changes
+- SA 0.5.x support. SQLAlchemy < 0.5 not supported anymore.
+- use nose instead of py.test for testing
+- Added --echo=True option for all commands, which will make the
+  sqlalchemy connection echo SQL statements.
+- Better PostgreSQL support, especially for schemas.
+- modification to the downgrade command to simplify the calling (old
+  way still works just fine)
+- improved support for SQLite
+- add support for check constraints (EXPERIMENTAL)
+- print statements removed from APIs
+- improved documentation
 
 0.4.5
 - work by Christian Simms to compare metadata against databases
diff --git a/README b/README
index ac2e89c..77a8467 100644
--- a/README
+++ b/README
@@ -1,14 +1,34 @@
-Help: 
-http://code.google.com/p/sqlalchemy-migrate/
-http://groups.google.com/group/migrate-users
+SQLAlchemy-migrate is a tool and a set of APIs for managing changes to
+database schemas.
+
+Help
+----
+
+Help is available at the project page [1] and at the public users
+mailing list [2].
+
+New releases and major changes are announced at the public announce
+mailing list [3] and at the Python package index [4].
+
+[1] http://code.google.com/p/sqlalchemy-migrate/
+[2] http://groups.google.com/group/migrate-users
+[3] http://groups.google.com/group/migrate-announce
+[4] http://pypi.python.org/pypi/sqlalchemy-migrate
+
+Tests and Bugs
+--------------
 
 To run automated tests:
 - Copy test_db.cfg.tmpl to test_db.cfg
-- Edit test_db.cfg with database connection strings sutable for running tests. 
-  (Use empty databases.)
+- Edit test_db.cfg with database connection strings suitable for
+  running tests.  (Use empty databases.)
 - python setup.py test
 
-Note that py.test[1] is required to run migrate's tests. It should be 
-installed automatically; if not, try "easy_install py".
+Note that nose [5] is required to run migrate's tests. It should be
+installed automatically; if not, try "easy_install nose".
 
-[1] http://codespeak.net/py/current/doc/test.html
+Please report any issues with sqlalchemy-migrate to the issue tracker
+at [6]
+
+[5] http://somethingaboutorange.com/mrl/projects/nose/
+[6] http://code.google.com/p/sqlalchemy-migrate/issues/list
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..a2f7736
--- /dev/null
+++ b/TODO
@@ -0,0 +1,3 @@
+- better MySQL support
+- fix unit tests for other databases than PostgreSQL (MySQL and SQLite
+  fail at test_changeset.test_fk(..))