From d62794b62aec4a82b16d38ab04baf2803385001e Mon Sep 17 00:00:00 2001 From: Stuart Glaser Date: Tue, 27 Nov 2007 23:32:51 -0600 Subject: [PATCH] Some docs. --- README | 17 +++++++++++++++++ fs.rb | 4 ++++ 2 files changed, 21 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..8badaf4 --- /dev/null +++ b/README @@ -0,0 +1,17 @@ +Teddybear is a filesystem that you can take with you. It's backed by +CouchDb, a distributed document database. CouchDb supports automatic +synchronization between databases, providing a simple method for +synchronizing the teddybear filesystem. + +Requirements: +- CouchDb >= 0.7 +- Ruby-JSON +- fusefs (Ruby) + + +To mount the teddybear filesystem, run: + + $ fs.rb some/place/to/mount/at + + +StuGlaser@gmail.com diff --git a/fs.rb b/fs.rb index 3db4984..a454b99 100755 --- a/fs.rb +++ b/fs.rb @@ -22,6 +22,10 @@ # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR # OTHER DEALINGS IN THE SOFTWARE. +# To mount the teddybear filesystem, run: +# +# $ fs.rb some/place/to/mount/at + require 'fusefs' require 'couch' -- 2.11.4.GIT