diff --git a/README.md b/README.md index 1af3b2c..1e7f159 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# go-validate-yourself -Go Struct and Field validation +Package go-validate-yourself +================ + +Package validator implements value validations for structs and individual fields based on tags. + +Installation +============ + +Just use go get. + + go get gopkg.in/joeybloggs/go-validate-yourself.v1 + +or to update + + go get -u gopkg.in/joeybloggs/go-validate-yourself.v1 + +And then just import the package into your own code. + + import "gopkg.in/joeybloggs/go-validate-yourself.v1" + +Usage +===== + +Please see http://godoc.org/gopkg.in/joeybloggs/go-validate-yourself.v1 for detailed usage docs.