Commits

Bryan O'Sullivan committed 923a9a8

Add README

Comments (0)

Files changed (1)

+# mysql: bindings to the mysqlclient library
+
+This library is a Haskell binding to the MySQL `mysqlclient` client
+library.  It is a fairly faithful, low level library that implements
+most of the MySQL client API.
+
+This library deliberately avoids the question of providing a "good"
+API. Its purpose is to serve as a base on which higher-level libraries
+can be build.
+
+# To do
+
+* Add support for prepared statements. This API is huge and of dubious
+  performance worth, so it's not currently a priority for me. Patches
+  welcome!
+
+# Get involved!
+
+We are happy to receive bug reports, fixes, documentation enhancements,
+and other improvements.
+
+Please report bugs via the
+[github issue tracker](http://github.com/mailrank/mysql/issues).
+
+Master [git repository](http://github.com/mailrank/mysql):
+
+* `git clone git://github.com/mailrank/mysql.git`
+
+There's also a [Mercurial mirror](http://bitbucket.org/bos/mysql):
+
+* `hg clone http://bitbucket.org/bos/mysql`
+
+(You can create and contribute changes using either git or Mercurial.)
+
+# Authors
+
+This library is written and maintained by Bryan O'Sullivan,
+<bos@mailrank.com>.