From 7806bcd471734b15aa42a4bc7947421c52ac09ce Mon Sep 17 00:00:00 2001 From: Maxim Bublis Date: Tue, 3 Dec 2013 13:59:31 +0400 Subject: [PATCH] Added example and notice of tested Go versions --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 43120f1..b63ee62 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,28 @@ Use the `go` command: $ go get github.com/satori/uuid.go +## Requirements + +UUID package requires any stable version of Go Programming Language. +It is tested against following versions of Go: 1.0, 1.1, 1.2 + +## Example + +```go +package main + +import ( + "fmt" + "github.com/satori/uuid.go" +) + +func main() { + // Creating UUID Version 4 + u := uuid.NewV4() + fmt.Printf("UUIDv4: %s", u) +} +``` + ## Documentation [Documentation](http://godoc.org/github.com/satori/uuid.go) is hosted at GoDoc project. @@ -29,4 +51,5 @@ Use the `go` command: Copyright (C) 2013 by Maxim Bublis . -UUID package released under MIT License. See [LICENSE](https://github.com/satori/uuid.go/blob/master/LICENSE) for details. +UUID package released under MIT License. +See [LICENSE](https://github.com/satori/uuid.go/blob/master/LICENSE) for details.