diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad01d2e --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# oid36 + +encode ObjectID to Base36 and back + +```go + id := primitive.NewObjectID().Hex() + fmt.Println(id) + out, e := oid36.ObjectIDToBase36(id) + if e != nil { + t.Error(e) + t.Fail() + return + } + fmt.Println(out) +``` + +### Acknowledgements + +Shamelessly stolen base36 code from [github.com/martinlindhe/base36](https://github.com/martinlindhe/base36).