ms/config
2
0
Fork 0
Code Actions

Update README.md

Browse Source
This commit is contained in:
eschao 2017-12-12 23:18:55 +08:00 committed by GitHub
parent 69dbb09aa2
commit e14ed1d5bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -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)
```