Skip to content

Optimize README: improve structure, add chain table, and contact info#34

Merged
GalaxySciTech merged 1 commit intomasterfrom
cursor/readme-a1f9
Apr 2, 2026
Merged

Optimize README: improve structure, add chain table, and contact info#34
GalaxySciTech merged 1 commit intomasterfrom
cursor/readme-a1f9

Conversation

@GalaxySciTech
Copy link
Copy Markdown
Owner

Summary

Overhauls the README.md to be more professional, scannable, and informative.

Changes

  • Header — Added a one-line tagline beneath the project name and a JitPack badge alongside the existing CI/issues/PR/contributors/license badges.
  • Navigation — Added a quick-links bar (Supported Chains · Quick Start · Integration · Offline Signing · Contact) for fast in-page navigation.
  • Introduction — Rewrote to clearly describe what Tokencore does (HD wallet derivation, encrypted keystore management, offline signing) and who it's for.
  • Supported Chains — Replaced the bullet list with a structured table showing chain names, supported token standards, and key features.
  • Quick Start — Streamlined the code examples with numbered steps and removed redundant boilerplate.
  • Offline Signing — Reorganized Bitcoin/Ethereum/TRON examples with inline comments for clarity.
  • Build & Test — Consolidated into one clean section.
  • Project Structure — Added a source tree diagram so contributors can orient themselves quickly.
  • Contact — Added Telegram (t.me/GalaxySciTech), kept the website link, and added a direct link to GitHub Issues.
  • Disclaimer — Moved the learning-purpose note to a clearly marked disclaimer at the bottom.
Open in Web Open in Cursor 

…d Telegram contact

Co-authored-by: Galaxy <GalaxySciTech@users.noreply.github.com>
@GalaxySciTech GalaxySciTech marked this pull request as ready for review April 2, 2026 13:58
@GalaxySciTech GalaxySciTech merged commit 454e849 into master Apr 2, 2026
3 checks passed
@GalaxySciTech GalaxySciTech deleted the cursor/readme-a1f9 branch April 2, 2026 13:58
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