From e14ed1d5bc31ae632e593d8d99ab20a519279aa0 Mon Sep 17 00:00:00 2001 From: eschao Date: Tue, 12 Dec 2017 23:18:55 +0800 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ce1bbf0..4486178 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ ## Introduction -**config** is a simple golang library and designed to read configurations from JSON, Yaml files, environment variables and command line. **config** depends on [go-yaml](https://github.com/go-yaml/yaml) to anlayze Yaml file and use built-in JSON library to handle JSON file. +**config** is a simple golang library and designed to read configurations from JSON, Yaml files, environment variables and command line. **config** depends on [go-yaml](https://github.com/go-yaml/yaml) to anlayze Yaml file and use built-in golang library to handle JSON file. ## Installation 1. Install [Yaml](https://github.com/go-yaml/yaml) library first: @@ -7,9 +7,23 @@ go get gopkg.in/yaml.v2 ``` -2. Run the below to install: +2. Install **config** library: ``` go get github.com/eschao/config ``` ## Usage +#### Defines **default** values +**config** library supports defining a default value for structure members by using **default** keyword in structure tags +```golang + type Database struct { + Username string `default:"admin"` + Password string `default:"admin"` + } +``` + +After specified default value in tags, calls ```config.ParseDefault(interface{})``` to set it on structure instance, example codes as the below: +```golang + dbConfig := Database{} + config.ParseDefault(&dbConfig) +```