diff --git a/README.md b/README.md new file mode 100644 index 0000000..3d44441 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# go-iid + +Package **iid** provides quazi‐ monotonically‐increasing unique‐identifiers. + + +## Documention + +Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-iid + +[![GoDoc](https://godoc.org/github.com/reiver/go-iid?status.svg)](https://godoc.org/github.com/reiver/go-iid) + + +## Example + +Here is an example of using `package iid`: +```go +var id iid.IID = iid.Generate() +```