From 24c5dcecb15d3aad779b58fd077a063cfee5c01a Mon Sep 17 00:00:00 2001 From: Charles Iliya Krempeaux Date: Sun, 7 Nov 2021 21:11:26 -0800 Subject: [PATCH] initial commits --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c89c520..dfe47ac 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ -# go-iid +# go-xim -Package **iid** provides quazi‐ monotonically‐increasing unique‐identifiers. +Package **xim** provides quazi‐ monotonically‐increasing unique‐identifiers. The serialized form of the **IID** is safe to use as a _file_ or _directory_ name. ## Documention -Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-iid +Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-xim -[![GoDoc](https://godoc.org/github.com/reiver/go-iid?status.svg)](https://godoc.org/github.com/reiver/go-iid) +[![GoDoc](https://godoc.org/github.com/reiver/go-xim?status.svg)](https://godoc.org/github.com/reiver/go-xim) ## Example -Here is an example of using `package iid`: +Here is an example of using `package xim`: ```go -var id iid.IID = iid.Generate() +var id xim.IID = xim.Generate() ``` ## Representation @@ -30,9 +30,9 @@ Internally, the IID is compactly stored in an `uint64`. The anatomy of this is a always zero (1-bit) chaos (20-bits) ``` -The `iid.IID.UnixTime()` method will give you that 39-bit _unix timestamp_. +The `xim.IID.UnixTime()` method will give you that 39-bit _unix timestamp_. -And the `iid.IID.Chaos()` method will give you that 24-bit _chaos_. +And the `xim.IID.Chaos()` method will give you that 24-bit _chaos_. (The _chaos_ is just a randomness that helps make these IIDs unique, when multiple IIDs are being produced simultaneously.)