Permalink
Browse files

add readme

  • Loading branch information...
1 parent 1d15da1 commit f5e25a2cd2ce4a94540c99ebe3ec316f909f0fe5 @txus committed Sep 12, 2012
Showing with 24 additions and 3 deletions.
  1. +24 −3 README.md
View
@@ -1,10 +1,25 @@
-# C project
+# ShitDB
-TODO: Write a project description
+Shitty key-value store in C inspired by Redis.
## Usage
-TODO: Write usage instructions here
+ $ make
+ $ bin/shitdb
+
+Example session:
+
+ $ nc localhost 4999
+ SET foo "bar"
+ OK
+ GET foo
+ "bar"
+ SET bar 123
+ OK
+ GET bar
+ 123
+ QUIT
+ Bye!
## Contributing
@@ -13,3 +28,9 @@ TODO: Write usage instructions here
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+## Who's this
+
+This was made by [Josep M. Bach (Txus)](http://txustice.me) under the MIT
+license. I'm [@txustice](http://twitter.com/txustice) on twitter (where you
+should probably follow me!).

0 comments on commit f5e25a2

Please sign in to comment.