cmd/bpa-operator/vendor/gopkg.in/ini.v1/README.md

   1 INI [![Build Status](https://travis-ci.org/go-ini/ini.svg?branch=master)](https://travis-ci.org/go-ini/ini) [![Sourcegraph](https://img.shields.io/badge/view%20on-Sourcegraph-brightgreen.svg)](https://sourcegraph.com/github.com/go-ini/ini)
   2 ===
   3
   4 ![](https://avatars0.githubusercontent.com/u/10216035?v=3&s=200)
   5
   6 Package ini provides INI file read and write functionality in Go.
   7
   8 ## Features
   9
  10 - Load from multiple data sources(`[]byte`, file and `io.ReadCloser`) with overwrites.
  11 - Read with recursion values.
  12 - Read with parent-child sections.
  13 - Read with auto-increment key names.
  14 - Read with multiple-line values.
  15 - Read with tons of helper methods.
  16 - Read and convert values to Go types.
  17 - Read and **WRITE** comments of sections and keys.
  18 - Manipulate sections, keys and comments with ease.
  19 - Keep sections and keys in order as you parse and save.
  20
  21 ## Installation
  22
  23 The minimum requirement of Go is **1.6**.
  24
  25 ```sh
  26 $ go get gopkg.in/ini.v1
  27 ```
  28
  29 Please add `-u` flag to update in the future.
  30
  31 ## Go Modules
  32
  33 For historical reason, people use two different import paths for this package: `github.com/go-ini/ini` and `gopkg.in/ini.v1`. If you get error similar to the following one:
  34
  35 ```
  36 go: finding github.com/go-ini/ini v0.0.0-00010101000000-000000000000
  37 go: github.com/go-ini/ini@v0.0.0-00010101000000-000000000000: unknown revision 000000000000
  38 go: error loading module requirements
  39 ```
  40
  41 It is because one of your dependencies is using deprecated import path `github.com/go-ini/ini`, you can make a quick fix by adding the following line to your `go.mod` file (`v.1.44.0` was the latest version tagged on `master` branch):
  42
  43 ```
  44 replace github.com/go-ini/ini => gopkg.in/ini.v1 v1.44.0
  45 ```
  46
  47 ## Getting Help
  48
  49 - [Getting Started](https://ini.unknwon.io/docs/intro/getting_started)
  50 - [API Documentation](https://gowalker.org/gopkg.in/ini.v1)
  51
  52 ## License
  53
  54 This project is under Apache v2 License. See the [LICENSE](LICENSE) file for the full license text.