From 404fcbe88727c94236dac5cfb2a3191b6ba5f397 Mon Sep 17 00:00:00 2001
From: Joseph Werle <joseph.werle@gmail.com>
Date: Mon, 5 May 2014 09:05:32 -0400
Subject: update readme

---
 README.md    | 48 ++++++++++++++++++++++++++++++++++++++++++++++--
 murmurhash.h |  3 ++-
 test.c       |  1 +
 3 files changed, 49 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 8dfee15..88abea7 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,48 @@
-murmurhash.c
-============
+murmurhash
+===========
 
 MurmurHash3 general hash bashed lookup function implementation
+
+## about
+
+[MurmurHash](http://en.wikipedia.org/wiki/MurmurHash) is a non-cryptographic hash function suitable
+for general hash-based lookup. This implementation implements version 3
+of MurmurHash.
+
+## install
+
+[clib](https://github.com/clibs/clib):
+
+```sh
+$ clib install jwerle/murmurhash.c
+```
+
+## example
+
+```c
+
+#include <stdlib.h>
+#include <string.h>
+#include <murmurhash.h>
+
+int
+main (void) {
+  uint32_t seed = 0;
+  const char *key = "kinkajou";
+  uint32_t hash = murmurhash(key, (uint32_t) strlen(key), seed); // 0xb6d99cf8
+  return 0;
+}
+```
+
+## api
+
+```c
+uint32_t
+murmurhash (const char *key, uint32_t len, uint32_t seed);
+```
+
+Returns a murmur hash of `key' based on `seed' using the MurmurHash3 algorithm.
+
+## license
+
+MIT
diff --git a/murmurhash.h b/murmurhash.h
index 48d39bf..1941e0f 100644
--- a/murmurhash.h
+++ b/murmurhash.h
@@ -9,7 +9,8 @@
 #define MURMURHASH_H 1
 
 /**
- *
+ * Returns a murmur hash of `key' based on `seed'
+ * using the MurmurHash3 algorithm
  */
 
 uint32_t
diff --git a/test.c b/test.c
index 27b69ab..b67f458 100644
--- a/test.c
+++ b/test.c
@@ -48,6 +48,7 @@ main (void) {
   t("hey", seed, 0x12f94418);
   t("dude", seed, 0xef0487f3);
   t("test", seed, 0xba6bd213);
+  t("kinkajou", seed, 0xb6d99cf8);
 
 
   seed = 1;
-- 
cgit v1.2.3