1# INI
2
3[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/go-ini/ini/Go?logo=github&style=for-the-badge)](https://github.com/go-ini/ini/actions?query=workflow%3AGo)
4[![codecov](https://img.shields.io/codecov/c/github/go-ini/ini/master?logo=codecov&style=for-the-badge)](https://codecov.io/gh/go-ini/ini)
5[![GoDoc](https://img.shields.io/badge/GoDoc-Reference-blue?style=for-the-badge&logo=go)](https://pkg.go.dev/github.com/go-ini/ini?tab=doc)
6[![Sourcegraph](https://img.shields.io/badge/view%20on-Sourcegraph-brightgreen.svg?style=for-the-badge&logo=sourcegraph)](https://sourcegraph.com/github.com/go-ini/ini)
7
8![](https://avatars0.githubusercontent.com/u/10216035?v=3&s=200)
9
10Package ini provides INI file read and write functionality in Go.
11
12## Features
13
14- Load from multiple data sources(file, `[]byte`, `io.Reader` and `io.ReadCloser`) with overwrites.
15- Read with recursion values.
16- Read with parent-child sections.
17- Read with auto-increment key names.
18- Read with multiple-line values.
19- Read with tons of helper methods.
20- Read and convert values to Go types.
21- Read and **WRITE** comments of sections and keys.
22- Manipulate sections, keys and comments with ease.
23- Keep sections and keys in order as you parse and save.
24
25## Installation
26
27The minimum requirement of Go is **1.6**.
28
29```sh
30$ go get gopkg.in/ini.v1
31```
32
33Please add `-u` flag to update in the future.
34
35## Getting Help
36
37- [Getting Started](https://ini.unknwon.io/docs/intro/getting_started)
38- [API Documentation](https://gowalker.org/gopkg.in/ini.v1)
39- 中国大陆镜像：https://ini.unknwon.cn
40
41## License
42
43This project is under Apache v2 License. See the [LICENSE](LICENSE) file for the full license text.
44