Change wording to reflect future care on API stability. #25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andydotxyz
requested changes
Jun 22, 2022
README.md
Outdated
| @@ -111,14 +111,15 @@ Most logger module in the go ecosystem do provide an API that match the `log.Pri | |||
| - Support for updating arbitrary files | |||
|
|
|||
| ## API Compatibility Promises | |||
| The master branch of `selfupdate` is *not* guaranteed to have a stable API over time. For any production application, you should vendor your dependency on `selfupdate` with `go vendor`. | |||
| The master branch of `selfupdate` is *not* guaranteed to have a stable API over time. Still we will try hard to not break its API unecessarily and will follow a proper versionning of our release when necessary. | |||
There was a problem hiding this comment.
Oops, we missed that it is main now.
andydotxyz
approved these changes
Jun 22, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.