re
/
viper
forked from mirror/viper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add HCL support to the README file

This commit is contained in:
patdhlk 2015-12-13 21:47:41 +01:00 committed by Steve Francia
parent 8e6f2421dc
commit 79971f1ae7
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -12,7 +12,7 @@ to work within an application, and can handle all types of configuration needs
and formats. It supports: and formats. It supports:
* setting defaults * setting defaults
* reading from JSON, TOML, and YAML config files * reading from JSON, TOML, YAML and HCL config files
* live watching and re-reading of config files (optional) * live watching and re-reading of config files (optional)
* reading from environment variables * reading from environment variables
* reading from remote config systems (etcd or Consul), and watching changes * reading from remote config systems (etcd or Consul), and watching changes
@ -31,7 +31,7 @@ Viper is here to help with that.
Viper does the following for you: Viper does the following for you:
1. Find, load, and unmarshal a configuration file in JSON, TOML, or YAML. 1. Find, load, and unmarshal a configuration file in JSON, TOML, YAML or HCL.
2. Provide a mechanism to set default values for your different 2. Provide a mechanism to set default values for your different
configuration options. configuration options.
3. Provide a mechanism to set override values for options specified through 3. Provide a mechanism to set override values for options specified through
@ -72,7 +72,7 @@ viper.SetDefault("Taxonomies", map[string]string{"tag": "tags", "category": "cat
### Reading Config Files ### Reading Config Files
Viper requires minimal configuration so it knows where to look for config files. Viper requires minimal configuration so it knows where to look for config files.
Viper supports JSON, TOML and YAML files. Viper can search multiple paths, but Viper supports JSON, TOML, YAML and HCL files. Viper can search multiple paths, but
currently a single Viper instance only supports a single configuration file. currently a single Viper instance only supports a single configuration file.
Viper does not default to any configuration search paths leaving defaults decision Viper does not default to any configuration search paths leaving defaults decision
to an application. to an application.
@ -266,7 +266,7 @@ package:
`import _ "github.com/spf13/viper/remote"` `import _ "github.com/spf13/viper/remote"`
Viper will read a config string (as JSON, TOML, or YAML) retrieved from a path Viper will read a config string (as JSON, TOML, YAML or HCL) retrieved from a path
in a Key/Value store such as etcd or Consul. These values take precedence over in a Key/Value store such as etcd or Consul. These values take precedence over
default values, but are overridden by configuration values retrieved from disk, default values, but are overridden by configuration values retrieved from disk,
flags, or environment variables. flags, or environment variables.