lab/snowflake
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Move things around.

Browse Source
This commit is contained in:
Bruce Marriner 2018-02-01 02:42:33 +00:00
parent 18b124e694
commit 7d434bc4d8
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -16,17 +16,6 @@ This package should be considered stable and completed. Any additions in the
future will strongly avoid API changes to existing functions. Please see issues future will strongly avoid API changes to existing functions. Please see issues
for any remaining TODO items that are planned. for any remaining TODO items that are planned.
## Getting Started
### Installing
This assumes you already have a working Go environment, if not please see
[this page](https://golang.org/doc/install) first.
```sh
go get github.com/bwmarrin/snowflake
```
### ID Format ### ID Format
By default, the ID format follows the original Twitter snowflake format. By default, the ID format follows the original Twitter snowflake format.
* The ID as a whole is a 63 bit integer stored in an int64 * The ID as a whole is a 63 bit integer stored in an int64
@ -44,6 +33,17 @@ Each time you generate an ID, it works, like this.
* Then the Sequence Number is added, starting at 0 and incrementing for each ID generated in the same millisecond. If you generate enough IDs in the same millisecond that the sequence would roll over or overfill then the generate function will pause until the next millisecond. * Then the Sequence Number is added, starting at 0 and incrementing for each ID generated in the same millisecond. If you generate enough IDs in the same millisecond that the sequence would roll over or overfill then the generate function will pause until the next millisecond.
Using the default settings, this allows for 4096 unique IDs to be generated every millisecond, per Node ID. Using the default settings, this allows for 4096 unique IDs to be generated every millisecond, per Node ID.
## Getting Started
### Installing
This assumes you already have a working Go environment, if not please see
[this page](https://golang.org/doc/install) first.
```sh
go get github.com/bwmarrin/snowflake
```
### Usage ### Usage