Skip to content

Commit a1e2bb1

Browse files
Add fields info to readme.
1 parent a4637c9 commit a1e2bb1

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ Package config load configuration values into given struct.
44

55
The struct must be passed by reference.
66

7-
Fields can have the `env` tag which defines the key of the value. If no tag provided, the key will be the
8-
uppercase full path of the field (all the fields names starting the root until current field, joined by underscore).
7+
Fields must be exported. Unexported fields will be ignored. They can have the `env` tag which defines the key
8+
of the value. If no tag provided, the key will be the uppercase full path of the field (all the fields names
9+
starting the root until current field, joined by underscore).
910

1011
The `json` tag will be used for loading from JSON.
1112

0 commit comments

Comments
 (0)