44 lines
1.7 KiB
Markdown
44 lines
1.7 KiB
Markdown
# INI
|
||
|
||
[](https://github.com/go-ini/ini/actions?query=branch%3Amain)
|
||
[](https://codecov.io/gh/go-ini/ini)
|
||
[](https://pkg.go.dev/github.com/go-ini/ini?tab=doc)
|
||
[](https://sourcegraph.com/github.com/go-ini/ini)
|
||
|
||
|
||
|
||
Package ini provides INI file read and write functionality in Go.
|
||
|
||
## Features
|
||
|
||
- Load from multiple data sources(file, `[]byte`, `io.Reader` and `io.ReadCloser`) with overwrites.
|
||
- Read with recursion values.
|
||
- Read with parent-child sections.
|
||
- Read with auto-increment key names.
|
||
- Read with multiple-line values.
|
||
- Read with tons of helper methods.
|
||
- Read and convert values to Go types.
|
||
- Read and **WRITE** comments of sections and keys.
|
||
- Manipulate sections, keys and comments with ease.
|
||
- Keep sections and keys in order as you parse and save.
|
||
|
||
## Installation
|
||
|
||
The minimum requirement of Go is **1.13**.
|
||
|
||
```sh
|
||
$ go get gopkg.in/ini.v1
|
||
```
|
||
|
||
Please add `-u` flag to update in the future.
|
||
|
||
## Getting Help
|
||
|
||
- [Getting Started](https://ini.unknwon.io/docs/intro/getting_started)
|
||
- [API Documentation](https://gowalker.org/gopkg.in/ini.v1)
|
||
- 中国大陆镜像：https://ini.unknwon.cn
|
||
|
||
## License
|
||
|
||
This project is under Apache v2 License. See the [LICENSE](LICENSE) file for the full license text.
|