diff --git a/CHANGELOG.md b/CHANGELOG.md index bdcb511..56f9e22 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ # Changelog -## v1.0.0-rc2 (unreleased) +## v1.0.0 (07-31-2017) + +First stable release: no breaking changes will be made in the 1.x series. - **[Breaking]** `ValueType` and `GetType` functionality is removed in favor of using `reflect.Kind`. @@ -17,6 +19,6 @@ - **[Breaking]** Unexport NewYAMLProviderFromReader* functions. - **[Breaking]** `NewProviderGroup` returns an error. -## v1.0.0-rc1 (26 Jun 2017) +## v1.0.0-rc1 (06-26-2017) - **[Breaking]** `Provider` interface was trimmed down to 2 methods: `Name` and `Get` \ No newline at end of file diff --git a/README.md b/README.md index ae23033..b5630e7 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,20 @@ Package `config` allows users to: * Get components working with minimal configuration * Override any field if the default doesn't make sense for their use case +## Installation +We recommend locking to [SemVer](http://semver.org/) range `^1` using +[Glide](https://github.com/Masterminds/glide): + +``` +glide get 'go.uber.org/config#^1 +``` + +## Stability + +This library is `v1` and follows [SemVer](http://semver.org/) strictly. + +No breaking changes will be made to exported APIs before `v2.0.0`. + ## License [MIT](LICENSE.txt) diff --git a/glide.lock b/glide.lock index 07a7db9..b743924 100644 --- a/glide.lock +++ b/glide.lock @@ -1,23 +1,21 @@ -hash: a867686558437d6c4ee4a4f7985271f07e4dd82b0650067b36769a09f76bb0a9 -updated: 2017-07-26T10:43:55.775960678-07:00 +hash: bc86f2e1ca95a651be64c94f23db29be3b606272d03bc66bb8c8efca2b0a3545 +updated: 2017-07-31T12:01:52.034767994-07:00 imports: - name: github.com/pkg/errors version: 645ef00459ed84a119197bfb8d8205042c6df63d -- name: github.com/spf13/pflag - version: e57e3eeb33f795204c1ca35f56c44f83227c6e66 - name: gopkg.in/validator.v2 version: 07ffaad256c8e957050ad83d6472eb97d785013d - name: gopkg.in/yaml.v2 version: 25c4ec802a7d637f88d584ab26798e94ad14c13b testImports: - name: github.com/davecgh/go-spew - version: 6d212800a42e8ab5c146b8ace3490ee17e5225f9 + version: adab96458c51a58dc1783b3335dcce5461522e75 subpackages: - spew - name: github.com/google/gofuzz version: 24818f796faf91cd76ec7bddd72458fbced7a6c1 - name: github.com/pmezard/go-difflib - version: d8ed2627bdf02c080bf22230dbb337003b7aba2d + version: 792786c7400a136282c1664665ae0a8db921c6c2 subpackages: - difflib - name: github.com/spf13/cast diff --git a/glide.yaml b/glide.yaml index 3e63ff7..f0cbc12 100644 --- a/glide.yaml +++ b/glide.yaml @@ -2,7 +2,6 @@ package: go.uber.org/config import: - package: gopkg.in/validator.v2 - package: gopkg.in/yaml.v2 -- package: github.com/spf13/pflag - package: github.com/pkg/errors version: ~0.8.0 testImport: diff --git a/version.go b/version.go index 6e7ac26..1853a4c 100644 --- a/version.go +++ b/version.go @@ -21,4 +21,4 @@ package config // import "go.uber.org/config" // Version is the current version of config. -const Version = "1.0.0-rc2" +const Version = "1.0.0"