Skip to content

Commit

Permalink
add readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
benoitc committed Oct 24, 2009
1 parent 46e8de8 commit e7cecdc
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@

couchbeam 0.3 - 2009 (c) Benoît Chesneau <[email protected]>
---------------------------------------------------------------

**couchbeam** is a simple erlang CouchDB framework. couchbeam provides you a full featured and easy client to access and manage multiple couchdb Nodes.

Couchbeam is under Apache License 2. see LICENSE file for more details.

Full documentation of the project is on this [url](http://benoitc.github.com/couchbeam).



requirements
------------
* Erlang/OTP R12-B or newer (compiler to build, kernel,stdlib,ssl,crypto to run)
* GNU Make (might actually build with some other make as well)
* [Etap](http://github.com/ngerakines/etap/) (for testing)

installation
------------
To bulid the application simply run 'make'. This should build .beam, .app
files and documentation.

Code integrate [lhttpc](http://bitbucket.org/etc/lhttpc/src/) but use your own as well.

To run tests run 'make test'.
To generate doc, run 'make docs'.

0 comments on commit e7cecdc

Please sign in to comment.