Skip to content

Commit

Permalink
Documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
tarcieri committed Mar 21, 2013
1 parent 4198e30 commit 99129f5
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ Keyspace
[![Coverage Status](https://coveralls.io/repos/livingsocial/keyspace/badge.png?branch=master)](https://coveralls.io/r/livingsocial/keyspace)

End-to-end (i.e. client-side) encryption for key/value stores, using
[RbNaCl][rbnacl] for security.
[RbNaCl][rbnacl] for security and [Moneta][moneta] for persistence.

[rbnacl]: https://github.com/cryptosphere/rbnacl
[moneta]: https://github.com/minad/moneta

About
-----
Expand All @@ -28,11 +29,15 @@ This means there is no access control system (e.g. RBAC) other than the capabili
tokens themselves. Authorization is handled completely by whether or not you have
the necessary cryptographic tokens to carry out a desired action.

Keyspace is built on [RbNaCl][rbnacl], a Ruby wrapper to the
Keyspace is built on [Moneta][moneta], an abstract API to many kinds of key/value
stores including all ActiveRecord compatible databases, Redis, Riak, Cassandra,
CouchDB, MongoDB, and many others. If there's a key/value store you would like
to persist to, Moneta probably supports it.

Cryptogarphy in Keyspace is handled by [RbNaCl][rbnacl], a Ruby wrapper to the
[Networking and Cryptography][nacl] library by Daniel J. Bernstein.

[capabilities]: http://en.wikipedia.org/wiki/Capability-based_security
[rbnacl]: https://github.com/cryptosphere/rbnacl
[nacl]: http://nacl.cr.yp.to/

Status
Expand Down

0 comments on commit 99129f5

Please sign in to comment.