Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change wording to reflect future care on API stability. #25

Merged
merged 3 commits into from
Jun 22, 2022
Merged

Change wording to reflect future care on API stability. #25

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f4aa6f
Change wording to reflect future care on API stability.
Jun 21, 2022
745faf5
We did move to the main branch.
Jun 22, 2022
68e2261
Fix typo.
Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 main 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.

The `selfupdate` package makes the following promises about API compatibility:
1. A list of all API-breaking changes will be documented in this README.
1. `selfupdate` will strive for as few API-breaking changes as possible.

## API Breaking Changes
- **May 30, 2022**: Many changes moving to a new API that will be supported going forward.
- **June 22, 2022**: First tagged release, v0.1.0.

## License
Apache