aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/kevinburke/go.uuid/README.md
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2018-07-16 23:20:23 +0200
committerMichael Muré <batolettre@gmail.com>2018-07-16 23:23:43 +0200
commit1d678dfdfa026968dbb19795c9bed16385603b21 (patch)
treecac862609d0103ee30da39cd0054b11884248e9d /vendor/github.com/kevinburke/go.uuid/README.md
parent131a862d313f12808d63e832126317a27226940b (diff)
downloadgit-bug-1d678dfdfa026968dbb19795c9bed16385603b21.tar.gz
vendor dependencies with dep
Diffstat (limited to 'vendor/github.com/kevinburke/go.uuid/README.md')
-rw-r--r--vendor/github.com/kevinburke/go.uuid/README.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/vendor/github.com/kevinburke/go.uuid/README.md b/vendor/github.com/kevinburke/go.uuid/README.md
new file mode 100644
index 00000000..7c46f66c
--- /dev/null
+++ b/vendor/github.com/kevinburke/go.uuid/README.md
@@ -0,0 +1,68 @@
+# UUID package for Go language
+
+This is a fork of satori/go.uuid that won't change the existing API.
+
+[![Build Status](https://travis-ci.org/kevinburke/go.uuid.png?branch=master)](https://travis-ci.org/kevinburke/go.uuid)
+[![Coverage Status](https://coveralls.io/repos/github/kevinburke/go.uuid/badge.svg?branch=master)](https://coveralls.io/github/kevinburke/go.uuid)
+[![GoDoc](http://godoc.org/github.com/kevinburke/go.uuid?status.png)](http://godoc.org/github.com/kevinburke/go.uuid)
+
+This package provides pure Go implementation of Universally Unique Identifier (UUID). Supported both creation and parsing of UUIDs.
+
+With 100% test coverage and benchmarks out of box.
+
+Supported 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 (RFC 4122)
+* Version 4, based on random numbers (RFC 4122)
+* Version 5, based on SHA-1 hashing (RFC 4122)
+
+## Installation
+
+Use the `go` command:
+
+ $ go get github.com/kevinburke/go.uuid
+
+## Requirements
+
+UUID package requires Go >= 1.5.
+
+## Example
+
+```go
+package main
+
+import (
+ "fmt"
+
+ "github.com/kevinburke/go.uuid"
+)
+
+func main() {
+ // Creating UUID Version 4
+ u1 := uuid.NewV4()
+ fmt.Printf("UUIDv4: %s\n", u1)
+
+ // Parsing UUID from string input
+ u2, err := uuid.FromString("6ba7b810-9dad-11d1-80b4-00c04fd430c8")
+ if err != nil {
+ fmt.Printf("Something gone wrong: %s", err)
+ }
+ fmt.Printf("Successfully parsed: %s", u2)
+}
+```
+
+## Documentation
+
+[Documentation](http://godoc.org/github.com/kevinburke/go.uuid) is hosted at GoDoc project.
+
+## Links
+* [RFC 4122](http://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)
+
+## Copyright
+
+Copyright (C) 2013-2018 by Maxim Bublis <b@codemonkey.ru>.
+
+UUID package released under MIT License.
+See [LICENSE](https://github.com/kevinburke/go.uuid/blob/master/LICENSE) for details.