From 69dbb09aa26629c8cd1084a72d20f55231485f0e Mon Sep 17 00:00:00 2001 From: eschao Date: Tue, 12 Dec 2017 22:51:25 +0800 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74e2089..ce1bbf0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ -# Config -A golang library for configuration +## 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. + +## Installation +1. Install [Yaml](https://github.com/go-yaml/yaml) library first: +``` +go get gopkg.in/yaml.v2 +``` + +2. Run the below to install: +``` +go get github.com/eschao/config +``` + +## Usage