added first readme

Author: Ompluscator

README.md

@@ -1,3 +1,69 @@
-# GO dynamic struct
+# Golang dynamic struct
 
-In progress...
+*Still in progress*
+
+Package dynamic struct provides possibility to dynamically, in runtime,
+extend existing defined structs or to provide completely new struct.
+
+Main features:
+* Building completely new struct in runtime
+* Extending existing struct in runtime
+* Adding new fields into struct
+* Removing existing fields from struct
+* Modifying fields' types and tags
+
+Works out-of-the-box with:
+* https://github.com/go-playground/form
+* https://github.com/go-playground/validator
+* https://github.com/leebenson/conform
+* https://golang.org/pkg/encoding/json/
+
+Examples:
+```go
+package main
+
+import (
+"encoding/json"
+"fmt"
+"log"
+
+"github.com/ompluscator/dynamic-struct"
+)
+
+func main() {
+instance := dynamic_struct.NewBuilder().
+AddField("Integer", 0, `json:"int"`).
+AddField("Text", "", `json:"someText"`).
+AddField("Float", 0.0, `json:"double"`).
+AddField("Boolean", false, "").
+AddField("Slice", []int{}, "").
+AddField("Anonymous", "", `json:"-"`).
+Build()
+
+data := []byte(`
+{
+ "int": 123,
+ "someText": "example",
+ "double": 123.45,
+ "Boolean": true,
+ "Slice": [1, 2, 3],
+ "Anonymous": "avoid to read",
+ "NilFloat": 567
+}
+`)
+
+err := json.Unmarshal(data, &instance)
+if err != nil {
+log.Fatal(err)
+}
+
+data, err = json.Marshal(instance)
+if err != nil {
+log.Fatal(err)
+}
+
+fmt.Println(string(data))
+// Out:
+// {"int":123,"someText":"example","double":123.45,"Boolean":true,"Slice":[1,2,3]}
+}
+```

builder_test.go

@@ -2,13 +2,13 @@ package dynamic_struct
 
 import (
 "encoding/json"
-"gopkg.in/go-playground/validator.v9"
 "net/url"
 "reflect"
 "testing"
 
 "github.com/go-playground/form"
 "github.com/leebenson/conform"
+"gopkg.in/go-playground/validator.v9"
 )
 
 func TestNewBuilder(t *testing.T) {