Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Kelwing committed Nov 27, 2022
1 parent 5c7bd36 commit b928f01
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# snowflake

[![GoDoc](https://img.shields.io/badge/pkg.go.dev-doc-blue)](http://pkg.go.dev/.)

Package snowflake provides a simple snowflake ID generator
along with interface implementations to make it easy to use
with database/sql and encoding/json.
Expand All @@ -15,6 +17,18 @@ This MUST be called before any calls to Generate.

## Types

### type [NullSnowflake](/null_snowflake.go#L12)

`type NullSnowflake struct { ... }`

NullSnowflake is a nullable Snowflake

#### func [NewNullSnowflake](/null_snowflake.go#L18)

`func NewNullSnowflake(s Snowflake, valid bool) NullSnowflake`

NewNullSnowflake creates a new NullSnowflake

### type [Snowflake](/snowflake.go#L55)

`type Snowflake uint64`
Expand All @@ -35,7 +49,7 @@ import (
"fmt"
"time"

"github.com/Sparrow-Project/snowflake"
"github.com/Project-Sparrow/snowflake"
)

func main() {
Expand Down

0 comments on commit b928f01

Please sign in to comment.