README

   1
   2     C O U C H    D B
   3     Ruby CouchDB Lib
   4
   5 //////////////////////////////////////////////////////////////////////////
   6
   7                 INTRODUCTION
   8
   9                 This is the CouchDB library for easy, clean, and sexy communication
  10                 with the excellent CouchDB persistent data store. You really should
  11                 read more about CouchDB, as it has some very sexy possibilities when
  12                 teamed up with a traditional RDBMS, but only time will really expose
  13                 everything that can be done with it.
  14
  15                 But for now, I give you this simple CouchDB library to fuck around
  16                 with, to get familiar with CouchDB, etc. Hope you like the work.
  17
  18                 The library is split into three primary sections:
  19
  20                 * Server
  21                 * DB
  22                 * Doc
  23
  24                 Each contain their own significant class to handle all operations
  25                 involving those aspects of each CouchDB data type. (There will be a
  26                 class specifically for Views as well.)
  27
  28                 That's about it.  It's supposed to be light.
  29                 Not much code and not too much ambition.
  30                 (Quoth _why from his Shoes appkit.)
  31
  32 //////////////////////////////////////////////////////////////////////////
  33
  34                 WHY NOT COUCHOBJECT?
  35
  36                 I think it's API is a little ugly, really, and that's about it. I
  37                 want to take the time to make the API very friendly and sexy, but
  38                 also improve upon the functionality as best as I can.
  39
  40 //////////////////////////////////////////////////////////////////////////
  41
  42                 DEPENDENCIES
  43
  44                 CouchDB (the library) requires a few libraries in order to function.
  45                 Most of these libraries are already available, but some you need to
  46                 install (via their respective gems) manually. These are marked with
  47                 a spiffy little *.
  48
  49                 * Net/HTTP
  50                 * RubyGems*
  51                 * JSON Ruby Library*
  52
  53 //////////////////////////////////////////////////////////////////////////
  54
  55                 BUILDING AND INSTALLING
  56
  57                 1. Install RubyGems if you haven't already. RubyGems is similar to
  58                    apt-get and port.
  59                         a. Download RubyGems from http://rubyforge.org/frs/?group_id=126
  60                         b. Extract
  61                         c. $ ruby setup.rb
  62
  63                 2. Install the JSON gem
  64                         a. $ sudo gem install
  65
  66                 3. ...
  67
  68 //////////////////////////////////////////////////////////////////////////
  69
  70                 DOCUMENTATION
  71
  72                 The most recent developments and documentation can be found at:
  73                 http://couchdb.wikispaces.com/
  74
  75                 Be sure to check your base.rb file's version against the latest
  76                 version linked on the wiki.
  77
  78 //////////////////////////////////////////////////////////////////////////
  79
  80     LICENSE
  81
  82     Copyright (c) 2007 Matt Todd.
  83
  84     Permission is hereby granted, free of charge, to any person obtaining a copy
  85                 of this software and associated documentation files (the "Software"), to deal
  86                 in the Software without restriction, including without limitation the rights
  87                 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  88                 copies of the Software, and to permit persons to whom the Software is
  89                 furnished to do so, subject to the following conditions:
  90
  91                 The above copyright notice and this permission notice shall be included in
  92                 all copies or substantial portions of the Software.
  93
  94                 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  95                 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  96                 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  97                 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  98                 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  99                 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 100                 THE SOFTWARE.