From 3e79b36617608dc883bed7311792cc21031e44a3 Mon Sep 17 00:00:00 2001
From: Vishal Kuo <vishalkuo@users.noreply.github.com>
Date: Wed, 9 Nov 2016 21:33:22 -0500
Subject: [PATCH] Create README.md

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0d23b31
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# bimap
+A bidirectional map written in Go
+
+## Installation
+```
+go get github.com/vishalkuo/bimap
+```
+
+## Usage
+```
+import "github.com/vishalkuo/bimap"
+
+biMap := biMap.NewBiMap()
+biMap.Insert("key", "value")
+val, ok := biMap.InverseGet("value") // val should be "key", ok should be true
+biMap.Delete("key")
+biMap.Size() // == 0
+```