diff options
author | nanohard <nanohard@users.noreply.github.com> | 2018-08-18 19:29:35 -0500 |
---|---|---|
committer | Steve Manuel <nilslice@gmail.com> | 2018-08-19 21:08:03 -0600 |
commit | 3c15499b7dd96f68262f59a368cf215b4b4c39a1 (patch) | |
tree | 12202f2599bba2f4107d679363480d56cf361f79 /cmd/ponzu/vendor/github.com/gofrs/uuid/README.md | |
parent | 83d740d8437d6cd55ad5ac8e3a293221c24260df (diff) |
Replaced satori/go.uuid with gofrs/uuid. (#268)
* Changed files to use new uuid pkg.
* Replace satori/go.uuid with gofrs/uuid. Closes #257.
* Deleted satori/go.uuid folder. Closes #257.
Diffstat (limited to 'cmd/ponzu/vendor/github.com/gofrs/uuid/README.md')
-rw-r--r-- | cmd/ponzu/vendor/github.com/gofrs/uuid/README.md | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/cmd/ponzu/vendor/github.com/gofrs/uuid/README.md b/cmd/ponzu/vendor/github.com/gofrs/uuid/README.md new file mode 100644 index 0000000..e1e2b2e --- /dev/null +++ b/cmd/ponzu/vendor/github.com/gofrs/uuid/README.md @@ -0,0 +1,101 @@ +# UUID + +[](https://github.com/gofrs/uuid/blob/master/LICENSE) +[](https://travis-ci.org/gofrs/uuid) +[](http://godoc.org/github.com/gofrs/uuid) +[](https://coveralls.io/github/gofrs/uuid) +[](https://goreportcard.com/report/github.com/gofrs/uuid) + +Package uuid provides a pure Go implementation of Universally Unique Identifiers +(UUID) variant as defined in RFC-4122. This package supports both the creation +and parsing of UUIDs in different formats. + +This package supports the following UUID versions: +* Version 1, based on timestamp and MAC address (RFC-4122) +* Version 2, based on timestamp, MAC address and POSIX UID/GID (DCE 1.1) +* Version 3, based on MD5 hashing of a named value (RFC-4122) +* Version 4, based on random numbers (RFC-4122) +* Version 5, based on SHA-1 hashing of a named value (RFC-4122) + +## Project History + +This project was originally forked from the +[github.com/satori/go.uuid](https://github.com/satori/go.uuid) repository after +it appeared to be no longer maintained, while exhibiting [critical +flaws](https://github.com/satori/go.uuid/issues/73). We have decided to take +over this project to ensure it receives regular maintenance for the benefit of +the larger Go community. + +We'd like to thank Maxim Bublis for his hard work on the original iteration of +the package. + +## License + +This source code of this package is released under the MIT License. Please see +the [LICENSE](https://github.com/gofrs/uuid/blob/master/LICENSE) for the full +content of the license. + +## Recommended Package Version + +We recommend using v2.0.0+ of this package, as versions prior to 2.0.0 were +created before our fork of the original package and have some known +deficiencies. + +## Installation + +It is recommended to use a package manager like `dep` that understands tagged +releases of a package, as well as semantic versioning. + +If you are unable to make use of a dependency manager with your project, you can +use the `go get` command to download it directly: + +```Shell +$ go get github.com/gofrs/uuid +``` + +## Requirements + +Due to subtests not being supported in older versions of Go, this package is +only regularly tested against Go 1.7+. This package may work perfectly fine with +Go 1.2+, but support for these older versions is not actively maintained. + +## Usage + +Here is a quick overview of how to use this package. For more detailed +documentation, please see the [GoDoc Page](http://godoc.org/github.com/gofrs/uuid). + +```go +package main + +import ( + "log" + + "github.com/gofrs/uuid" +) + +// Create a Version 4 UUID, panicking on error. +// Use this form to initialize package-level variables. +var u1 = uuid.Must(uuid.NewV4()) + +func main() { + // Create a Version 4 UUID. + u2, err := uuid.NewV4() + if err != nil { + log.Fatalf("failed to generate UUID: %v", err) + } + log.Printf("generated Version 4 UUID %v", u2) + + // Parse a UUID from a string. + s := "6ba7b810-9dad-11d1-80b4-00c04fd430c8" + u3, err := uuid.FromString(s) + if err != nil { + log.Fatalf("failed to parse UUID %q: %v", s, err) + } + log.Printf("successfully parsed UUID %v", u3) +} +``` + +## References + +* [RFC-4122](https://tools.ietf.org/html/rfc4122) +* [DCE 1.1: Authentication and Security Services](http://pubs.opengroup.org/onlinepubs/9696989899/chap5.htm#tagcjh_08_02_01_01) |