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 +```