Create README.md

This commit is contained in:
Vishal Kuo 2016-11-09 21:33:22 -05:00 committed by GitHub
parent 392b758d5e
commit 3e79b36617

18
README.md Normal file
View file

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