Permalink
Browse files

Update documentation

  • Loading branch information...
1 parent 8bb4340 commit d23c6b7b865e49faa5326c7b3698530803aa7ae5 @emk committed Dec 28, 2011
Showing with 9 additions and 1 deletion.
  1. +9 −1 README.md
View
10 README.md
@@ -1,6 +1,8 @@
## cstore
-**Warning: This is a random toy, not a production-ready library.**
+**Warning: This is a random toy, not a production-ready service. It will
+eat your data. It stores all data in RAM, and uses the same Redis backend
+for unit tests and standalone servers. This repository may go away.**
The `cstore` server is a distributed, content-based storage system. Like
`git`, it stores binary blobs indexed by cryptographic hash codes. The
@@ -28,6 +30,12 @@ add a file to the store:
curl "http://localhost:12346/$HASH"
+### How it works
+
+See REDIS.md for a description of how the servers communicate.
+
+### Future ideas
+
In the future, I might add support for POST:
curl -i -X POST -d 'Hello, world!' http://localhost:12345/

0 comments on commit d23c6b7

Please sign in to comment.