Merge lp:~jml/txrestfulclient/readme into lp:txrestfulclient

[Jonathan Lange]

Add a README file

A readme file!

[James Westby (james-w)]

Thanks.

review: Approve

=== added file 'README'
--- README	1970-01-01 00:00:00 +0000
+++ README	2010-06-07 22:20:38 +0000
@@ -0,0 +1,53 @@
+txrestfulclient
+===============
+
+txrestfulclient is a client library in the style of lazr.restfulclient, but
+written with Twisted for use in Twisted applications.
+
+It also has a very nifty facility for caching results using couchdb.
+
+If you are using this, it's very likely that you might be interested in
+Launchpad::
+
+ * https://launchpad.net
+ * https://help.launchpad.net
+
+
+Dependencies
+------------
+
+ * Twisted 10.0 or better
+ * paisley (see https://launchpad.net/paisley)
+ * desktopcouch
+ * launchpadlib
+
+
+Using txrestfulclient
+---------------------
+
+See examples/lp_print_me.py.
+
+
+Contributing to txrestfulclient
+-------------------------------
+
+Run tests with::
+
+  trial txrestfulclient
+
+
+File bugs at::
+
+  https://bugs.launchpad.net/txrestfulclient
+
+
+Get the code with::
+
+  bzr branch lp:txrestfulclient
+
+
+Copyright
+---------
+
+txrestfulclient is copyright (c) James Westby <[e-mail]> and
+is available under the terms of the GNU LGPL 3+.