diff options
| author | Brad Anderson <brad@sankatygroup.com> | 2010-08-27 21:44:22 -0400 |
|---|---|---|
| committer | Brad Anderson <brad@sankatygroup.com> | 2010-08-27 21:44:22 -0400 |
| commit | 342b04f23ed625acb147bc628df641601ea8fbe7 (patch) | |
| tree | f25772047e62eaae601647cba9482ea7ce38f154 /apps/fabric/README.md | |
| parent | cd30116edd0b27df1366cb407ba47346af29ba05 (diff) | |
add README.md back in for apps
Diffstat (limited to 'apps/fabric/README.md')
| -rw-r--r-- | apps/fabric/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/apps/fabric/README.md b/apps/fabric/README.md new file mode 100644 index 00000000..2d7f1ae2 --- /dev/null +++ b/apps/fabric/README.md @@ -0,0 +1,27 @@ +## fabric + +Fabric is a collection of proxy functions for [CouchDB][1] operations in a cluster. These functions are used in [BigCouch][2] as the remote procedure endpoints on each of the cluster nodes. + +For example, creating a database is a straightforward task in standalone CouchDB, but for BigCouch, each node that will store a shard/partition for the database needs to receive and execute a fabric function. The node handling the request also needs to compile the results from each of the nodes and respond accordingly to the client. + +Fabric is used in conjunction with 'Rexi' which is also an application within BigCouch. + +### Getting Started +Dependencies: + * Erlang R13B-03 (or higher) + +Build with rebar: + make + +### License +[Apache 2.0][3] + +### Contact + * [http://cloudant.com][4] + * [info@cloudant.com][5] + +[1]: http://couchdb.apache.org +[2]: http://github.com/cloudant/bigcouch +[3]: http://www.apache.org/licenses/LICENSE-2.0.html +[4]: http://cloudant.com +[5]: mailto:info@cloudant.com |