2020-01-09 12:02:56 -08:00
|
|
|
|
# INI
|
|
|
|
|
|
|
2023-01-28 13:57:53 -08:00
|
|
|
|
[](https://github.com/go-ini/ini/actions?query=branch%3Amain)
|
2020-10-19 14:40:00 -07:00
|
|
|
|
[](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)
|
2020-01-09 12:02:56 -08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Package ini provides INI file read and write functionality in Go.
|
|
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
2020-08-09 15:29:54 -07:00
|
|
|
|
- Load from multiple data sources(file, `[]byte`, `io.Reader` and `io.ReadCloser`) with overwrites.
|
2020-01-09 12:02:56 -08:00
|
|
|
|
- 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
|
|
|
|
|
|
|
2023-01-28 13:57:53 -08:00
|
|
|
|
The minimum requirement of Go is **1.13**.
|
2020-01-09 12:02:56 -08:00
|
|
|
|
|
|
|
|
|
|
```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)
|
2020-10-19 14:40:00 -07:00
|
|
|
|
- 中国大陆镜像：https://ini.unknwon.cn
|
2020-01-09 12:02:56 -08:00
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
|
|
This project is under Apache v2 License. See the [LICENSE](LICENSE) file for the full license text.
|
