docs

Author: mcuadros

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Máximo Cuadros
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,54 @@
+go-defaults [![Build Status](https://travis-ci.org/mcuadros/go-defaults.png?branch=master)](https://travis-ci.org/mcuadros/go-defaults) [![GoDoc](https://godoc.org/github.com/mcuadros/go-defaults?status.png)](http://godoc.org/github.com/mcuadros/go-defaults)
+==============================
+
+This library allow to define a default value to any struct, this is made thanks to [struct tags](http://golang.org/pkg/reflect/#StructTag).
+
+> A StructTag is the tag string in a struct field.
+
+> By convention, tag strings are a concatenation of optionally space-separated key:"value" pairs. Each key is a non-empty string consisting of non-control characters other than space (U+0020 ' '), quote (U+0022 '"'), and colon (U+003A ':'). Each value is quoted using U+0022 '"' characters and Go string literal syntax.
+
+
+Installation
+------------
+
+The recommended way to install go-defaults
+
+```
+go get github.com/mcuadros/go-defaults
+```
+
+Examples
+--------
+
+A basic example:
+
+```go
+import "github.com/mcuadros/go-defaults"
+import "fmt"
+
+type ExampleBasic struct {
+    Foo bool   `default:"true"`
+    Bar string `default:"33"`
+    Qux int8
+}
+
+func NewExampleBasic() *ExampleBasic {
+    example := new(ExampleBasic)
+    SetDefaults(example)
+
+    return example
+}
+
+...
+
+test := NewExampleBasic()
+fmt.Println(test.Foo) //Prints: true
+fmt.Println(test.Bar) //Prints: 33
+fmt.Println(test.Qux) //Prints:
+
+```
+
+License
+-------
+
+MIT, see [LICENSE](LICENSE)