Skip to content

Commit

Permalink
Readme update for v0.3 release
Browse files Browse the repository at this point in the history
  • Loading branch information
jeevatkm committed Feb 16, 2016
1 parent 09c7907 commit e84f88a
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Robust & Easy to use model mapper and utility methods for Go. Typical methods increase productivity and make Go developement more fun :smile:

**v0.2 released and tagged on Jan 26, 2016**
***v0.3 released and tagged on Feb 16, 2016***

go-model tested with Go `v1.2` and above.

## Features
go-model provides handy methods (`Copy`, `Map`, `Clone`, `IsZero`, etc.) to process struct with below highlighted features. It's born from typical need while developing Go application or utility. I hope it's helpful!
go-model provides [handy methods](#methods) to process `struct` with below highlighted features. It's born from typical need while developing Go application or utility. I hope it's helpful!
* Embedded/Anonymous struct
* Multi-level nested struct/map/slice
* Pointer and non-pointer within struct/map/slice
* Struct within map and slice
* Embedded/Anonymous fields appear in map at same level as represented by Go
* Embedded/Anonymous struct fields appear in map at same level as represented by Go
* Interface within struct/map/slice
* Add global no traverse type to the list or use `notraverse` option in the struct field
* Options to name map key, omit empty fields, and instruct not to traverse with struct/map/slice
Expand Down Expand Up @@ -76,6 +76,7 @@ I want to convert my struct into Map (`map[string]interface{}`). Sure, go-model
// -, name, omitempty, notraverse to get desired result.
sr, _ := myapp.GetSearchResult( /* params here */ )

// Embedded/Anonymous struct fields appear in map at same level as represented by Go
srchResMap, err := model.Map(sr)
fmt.Println("Error:", err)

Expand Down Expand Up @@ -163,5 +164,8 @@ BTW, I'd like to know what you think about go-model. Kindly open an issue or sen
## Author
Jeevanandam M. - jeeva@myjeeva.com

## Contributors
Have a look on [Contributors](https://github.com/jeevatkm/go-model/graphs/contributors) page.

## License
go-model released under MIT license, refer [LICENSE](LICENSE) file.

0 comments on commit e84f88a

Please sign in to comment.