From 5b07787237ce0a88e638051a4f2b35db18617196 Mon Sep 17 00:00:00 2001 From: Jason Davies Date: Sun, 23 Jan 2011 20:24:44 +0000 Subject: [PATCH] Update README --- README.md | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5c71455..ee4413e 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,46 @@ CouchDB-FUSE ============ +A FUSE interface to CouchDB. See the [blog post][1] for more details. + +[1]: http://www.jasondavies.com/blog/2008/11/25/edit-couchdb-attachments-directly-with-couchdb-fuse/ + Requirements ------------ - * CouchDB-Python version SVN-r125 or greater + * [Python FUSE bindings](http://fuse.sourceforge.net/) + * [CouchDB-Python](http://code.google.com/p/couchdb-python/) 0.5 or greater Installation ------------ -This *should* be as easy as: +Make sure the requirements above are installed, then run `python setup.py +install`. You can also install the latest stable version from [PyPI][2] by +running `easy_install CouchDB-FUSE`. - easy_install CouchDB-FUSE +[2]: http://pypi.python.org/pypi/CouchDB-FUSE Usage ----- -Currently you can mount a CouchDB document's attachments on a given mount-point -as follows: + $ mkdir mnt + $ couchmount http://localhost:5984/jasondavies/_design%2Flinks mnt/ + $ ls mnt/ + $ touch mnt/foo + $ ls mnt/ + foo + $ + +Use cases +--------- + + * If you've read [My Couch or Yours? Shareable Apps Are The Future][3] by + jchris, this is a great time-saver if you want to edit HTML, JavaScript, CSS + or even image files directly using your favourite editor. + * Uploading large numbers of files repetitively through Futon or even via a + Python prompt becomes tedious very quickly: drag'n'drop or `cp *` is the way + forward! + +[3]: http://jchris.mfdz.com/code/2008/11/my_couch_or_yours__shareable_ap - couchmount http://hostname:port/dbname/doc_id mount-point +Happy Couching!