deac/couchrest_model
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

whitespace readme

Browse source
This commit is contained in:
Chris Anderson 2008-10-02 10:57:13 -07:00
parent f6f66407c7
commit f0be835f79
1 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.rdoc
View file

@ -1,8 +1,13 @@
== CouchRest - CouchDB, close to the metal
CouchRest is based on [CouchDB's couch.js test library](http://svn.apache.org/repos/asf/incubator/couchdb/trunk/share/www/script/couch.js), which I find to be concise, clear, and well designed. CouchRest lightly wraps CouchDB's HTTP API, managing JSON serialization, and remembering the URI-paths to CouchDB's API endpoints so you don't have to.
CouchRest is based on [CouchDB's couch.js test
library](http://svn.apache.org/repos/asf/incubator/couchdb/trunk/share/www/script/couch.js),
which I find to be concise, clear, and well designed. CouchRest lightly wraps
CouchDB's HTTP API, managing JSON serialization, and remembering the URI-paths
to CouchDB's API endpoints so you don't have to.
CouchRest's lighweight is designed to make a simple base for application and framework-specific object oriented APIs.
CouchRest's lighweight is designed to make a simple base for application and
framework-specific object oriented APIs.
=== Easy Install
@ -10,11 +15,16 @@ CouchRest's lighweight is designed to make a simple base for application and fra
=== Relax, it's RESTful
The core of Couchrest is Heroku’s excellent REST Client Ruby HTTP wrapper. REST Client takes all the nastyness of Net::HTTP and gives is a pretty face, while still giving you more control than Open-URI. I recommend it anytime you’re interfacing with a well-defined web service.
The core of Couchrest is Heroku’s excellent REST Client Ruby HTTP wrapper.
REST Client takes all the nastyness of Net::HTTP and gives is a pretty face,
while still giving you more control than Open-URI. I recommend it anytime
you’re interfacing with a well-defined web service.
=== Running the Specs
The most complete documentation is the spec/ directory. To validate your CouchRest install, from the project root directory run `rake`, or `autotest` (requires RSpec and optionally ZenTest for autotest support).
The most complete documentation is the spec/ directory. To validate your
CouchRest install, from the project root directory run `rake`, or `autotest`
(requires RSpec and optionally ZenTest for autotest support).
=== Examples