diff --git a/README.md b/README.md index bf85abc6..023bd987 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,9 @@ At GitHub, we manage thousands of nodes with a Puppet code base containing 500,0 `octocatalog-diff` is written in Ruby and is distributed as a gem. It runs on Mac OS and Unix/Linux platforms. -We consider the 1.x release of `octocatalog-diff` to be stable and production-quality. We continue to maintain and enhance `octocatalog-diff` to meet our own internal needs and to incorporate suggestions from the community. Please consult the [change log](/doc/CHANGELOG.md) for details. +**The current version of `octocatalog-diff` in the master branch is 0.99.rc1, a release candidate for version 1.0.** + +We consider the 1.x release of `octocatalog-diff` to be stable and production-quality. We continue to maintain and enhance `octocatalog-diff` to meet GitHub's internal needs and to incorporate suggestions from the community. Please consult the [change log](/doc/CHANGELOG.md) for details. ## How? @@ -51,7 +53,6 @@ The example above reflects the changes in the Puppet catalog from switching an u - [Requirements](/doc/requirements.md) - [Limitations](/doc/limitations.md) - [List of all command line options](/doc/optionsref.md) -- [API](/doc/dev/api.md) ### Project @@ -59,6 +60,7 @@ The example above reflects the changes in the Puppet catalog from switching an u - [Similar tools](/doc/similar.md) - [Contributing](/.github/CONTRIBUTING.md) - [Developer documentation](/doc/dev) +- [API documentation](/doc/dev/api.md) ## What's in a name? @@ -80,4 +82,4 @@ It requires 3rd party ruby gems found [here](/vendor/cache). It also includes po ## Authors -`octocatalog-diff` was designed and authored by [Kevin Paulisse](https://github.com/kpaulisse) and is now maintained, reviewed, and tested by the Site Reliability Engineering team at GitHub. +`octocatalog-diff` was designed and authored by [Kevin Paulisse](https://github.com/kpaulisse) and is now maintained, reviewed, and tested by Kevin and the rest of the Site Reliability Engineering team at GitHub. diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md index 44e45499..ccc21e67 100644 --- a/doc/CHANGELOG.md +++ b/doc/CHANGELOG.md @@ -9,9 +9,11 @@ 0.99.0rc1 -2017-xx-xx +2017-01-16 -This is a release candidate for `octocatalog-diff` version 1.0. Please use caution before using this in a production environment. Report any problems to us as in a new issue. +This is a release candidate for `octocatalog-diff` version 1.0. Please report any problems to us as in a new issue. + +The previous release (0.6.1) is available at: https://github.com/github/octocatalog-diff/tree/0.6.1

New Features

@@ -20,7 +22,6 @@ The most significant change in version 1.0 is the addition of the