Skip to content

Update the v5 version description #259

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

Merged
pavel-kirienko merged 2 commits into from
Jun 7, 2026
+2 −3
Merged

Update the v5 version description #259

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fa029c
Change version label to v5.0.alpha
pavel-kirienko Jun 7, 2026
8972597
Update README for v5.0.alpha API changes
pavel-kirienko Jun 7, 2026
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
5 changes: 2 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,10 @@ int main(void)

To release a new version, simply publish a new release on GitHub.

### v5.0 [WORK IN PROGRESS]
### v5.0.alpha

v5 is a major rework based on the experience gained from extensive production use of the previous revisions.
The API has been redesigned from scratch and as such there is no migration guide available;
please read the new `canard.h` to see how to use the library -- the new API is simpler than the old one.
The main intended use case is with [**Cy**](https://github.com/OpenCyphal-Garage/cy) rather than standalone.

Main changes:

Expand Down