Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jasondavies committed Jan 23, 2011
1 parent 3ead01e commit 5b07787
Showing 1 changed file with 30 additions and 6 deletions.
36 changes: 30 additions & 6 deletions 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!

0 comments on commit 5b07787

Please sign in to comment.