Skip to content

docs: deprecate releases in this repo, point to canton-devkit - #11

Draft
zheli wants to merge 1 commit into
mainfrom
zzz/readme-deprecation-notice-1124
Draft

docs: deprecate releases in this repo, point to canton-devkit#11
zheli wants to merge 1 commit into
mainfrom
zzz/readme-deprecation-notice-1124

Conversation

@zheli

@zheli zheli commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates README.md to make it clear that GitHub Releases in this repository are deprecated and that users should download from bitdynamics-ab/canton-devkit instead.

Changes

  • Add a prominent deprecation banner at the top of the README
  • Rewrite the intro to describe this repo as the Homebrew tap (not the primary release channel)
  • Retarget Quick Install curl/wget examples to canton-devkit/main/install.sh
  • Note that this repo's install.sh is legacy and should not be used
  • Update the Homebrew section to reference canton-devkit releases and upstream docs
  • Remove the Release Assets section
  • Add a cross-link to the canton-devkit getting-started guide for DPM install steps

Test plan

  • Verified README renders deprecation notice first
  • Verified all install/download links point to bitdynamics-ab/canton-devkit
  • Verified no remaining text implies releases are published on this repo
Open in Web Open in Cursor 

- Add prominent banner that GitHub Releases in this repo are deprecated
- Rewrite intro to describe this repo as the Homebrew tap
- Point Quick Install examples to canton-devkit/install.sh
- Update Homebrew section to reference canton-devkit releases
- Remove Release Assets section
- Add cross-links to canton-devkit docs

Co-authored-by: Zhe Li <linuxcity.jn@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants