mirror
/
enumer
mirror of https://github.com/dmarkham/enumer.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Updated readme

This commit is contained in:
Álvaro 2016-10-26 17:12:25 +01:00
parent d3da35e3d0
commit 04c93cadb4
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -13,6 +13,8 @@ from a REST API request... In short, from those places where using the real enum
be almost meaningless or hard to trace or use by a human. be almost meaningless or hard to trace or use by a human.
* When the flag `json` is provided, two more methods will be generated, `MarshalJSON()` and `UnmarshalJSON()`. Those make * When the flag `json` is provided, two more methods will be generated, `MarshalJSON()` and `UnmarshalJSON()`. Those make
the enum conform the `json.Marshaler` and `json.Unmarshaler` interfaces. Very useful to use it in JSON APIs. the enum conform the `json.Marshaler` and `json.Unmarshaler` interfaces. Very useful to use it in JSON APIs.
* When the flag `sql` is provided the methods for implementing the Scanner and Valuer interfaces will be also generated.
Useful when storing the enum in a database.
For example, if we have an enum type called `Pill`, For example, if we have an enum type called `Pill`,
```go ```go