Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
inhere committed Jan 14, 2019
1 parent 26485c3 commit de6eef2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Golang application config manage tool library.

> **[中文说明](README_cn.md)**
## Features

- Support multi format: `JSON`(default), `INI`, `YAML`, `TOML`, `HCL`
- `JSON` content support comments. will auto clear comments
- Support multi-file and multi-data loading
Expand All @@ -18,9 +20,11 @@ Golang application config manage tool library.
- Support data overlay and merge, automatically load by key when loading multiple copies of data
- Support get sub value by path, like `map.key` `arr.2`
- Support parse ENV name. like `envKey: ${SHELL}` -> `envKey: /bin/zsh`
- Generic api `Get` `Int` `String` `Bool` `Ints` `IntMap` `Strings` `StringMap` ...
- Generic api `Get` `Int` `Float` `String` `Bool` `Ints` `IntMap` `Strings` `StringMap` ...
- Complete unit test(code coverage > 95%)

> Provide a sub-package `dotenv` that supports importing data from files (eg `.env`) to ENV
## Only use INI

> If you just want to use INI for simple config management, recommended use [gookit/ini](https://github.com/gookit/ini)
Expand Down
2 changes: 2 additions & 0 deletions README_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
- 简洁的使用API `Get` `Int` `String` `Bool` `Ints` `IntMap` `Strings` `StringMap` ...
- 完善的单元测试(code coverage > 95%)

> 提供一个子包`dotenv`,支持从文件(eg `.env`)中导入数据到ENV
## 只使用INI

> 如果你仅仅想用INI来做简单配置管理,推荐使用 [gookit/ini](https://github.com/gookit/ini)
Expand Down

0 comments on commit de6eef2

Please sign in to comment.