updated rake for rdoc

improve_associations
Chris Anderson 2008-09-11 22:21:16 -07:00
parent b051cdd3a2
commit c7fae2eca9
3 changed files with 18 additions and 6 deletions

1
.gitignore vendored
View File

@ -1 +1,2 @@
.DS_Store
html/*

View File

@ -1,22 +1,22 @@
## CouchRest - CouchDB, close to the metal
== 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's lighweight is designed to make a simple base for application and framework-specific object oriented APIs.
### Easy Install
=== Easy Install
`sudo gem install jchris-couchrest -s http://gems.github.com`
sudo gem install jchris-couchrest -s http://gems.github.com
### Relax, it's RESTful
=== Relax, it's RESTful
The core of Couchrest is Herokus 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 youre interfacing with a well-defined web service.
### Running the Specs
=== 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).
### Examples
=== Examples
Quick Start:

View File

@ -1,4 +1,5 @@
require 'rake'
require "rake/rdoctask"
require 'spec/rake/spectask'
desc "Run all specs"
@ -12,4 +13,14 @@ Spec::Rake::SpecTask.new(:doc) do |t|
t.spec_files = FileList['spec/*_spec.rb']
end
desc "Generate the rdoc"
Rake::RDocTask.new do |rdoc|
files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
rdoc.rdoc_files.add(files)
rdoc.main = "README.rdoc"
rdoc.title = "CouchRest: Ruby CouchDB, close to the metal"
# rdoc.rdoc_dir = "doc/rdoc"
# rdoc.options << "--line-numbers" << "--inline-source"
end
task :default => :spec