Skip to content

docs: polish README, LICENSE, and CONTRIBUTING for open source release - #2

Merged
0xNyk merged 1 commit into
mainfrom
docs/readme-polish
Mar 3, 2026
Merged

docs: polish README, LICENSE, and CONTRIBUTING for open source release#2
0xNyk merged 1 commit into
mainfrom
docs/readme-polish

Conversation

@0xNyk

@0xNyk 0xNyk commented Mar 3, 2026

Copy link
Copy Markdown
Member

Summary

  • Rewrite README with professional structure: centered banner + nav, feature list, model comparison table, architecture tree, platform notes
  • Remove internal "What's Different from Handy" section (not relevant for public-facing docs)
  • Add dual copyright to LICENSE — preserves original author (CJ Pais) and adds fork maintainer (0xNyk)
  • Update all CONTRIBUTING.md links from upstream cjpais/Handy to 0xNyk/dictx
  • Remove dead Discord invite link

Test plan

  • All internal links resolve correctly
  • README renders cleanly on GitHub
  • LICENSE follows MIT dual-copyright convention

- Rewrite README with professional structure, feature table, model
  comparison, architecture tree, and cleaner navigation
- Remove internal "What's Different from Handy" section
- Add dual copyright to LICENSE (original author + fork maintainer)
- Update CONTRIBUTING.md links from upstream Handy to Dictx repo
- Remove dead Discord link from CONTRIBUTING.md
@0xNyk
0xNyk merged commit 24656b5 into main Mar 3, 2026
1 of 4 checks passed
@0xNyk
0xNyk deleted the docs/readme-polish branch March 3, 2026 08:28
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.

1 participant