Skip to content

docs: Polish README for the initial Hex release#57

Merged
zacky1972 merged 1 commit into
mainfrom
46
May 16, 2026
Merged

docs: Polish README for the initial Hex release#57
zacky1972 merged 1 commit into
mainfrom
46

Conversation

@zacky1972
Copy link
Copy Markdown
Owner

Summary

  • Polishes README.md for the initial Hex v0.1.0 release.
  • Replaces conditional installation wording with release-oriented Hex dependency instructions.
  • Adds canonical Hex package / HexDocs links and states that they become live after publishing.
  • Documents user prerequisites for Elixir/OTP and Docker.
  • Adds a minimal runtime-configuration quick start and a Docker runtime example using the actual v0.1.0 public API.
  • Separates v0.1.0 released preview functionality from future LSP client roadmap work.
  • Fixes README formatting by using fenced code blocks and proper Markdown tables.

Notes

Only README.md is changed. The final ## License section in README.md is preserved byte-for-byte by the apply script.

The apply script verifies that the branch includes the latest origin/main when a Git origin remote is available, then checks for the release-scope, Hex metadata, and changelog readiness markers that issue #46 builds on.

Validation

Run from the repository root:

bash /path/to/issue-46-readme-polish-apply.sh
mix format --check-formatted
mix docs
mix check

The apply script also validates that:

  • the latest-main readiness docs and metadata markers are present before applying;
  • the README ## License section is unchanged after applying;
  • fenced code blocks are balanced;
  • old roadmap / conditional installation wording is gone; and
  • git diff --check -- README.md passes when run inside a Git worktree.

@zacky1972 zacky1972 merged commit 80e52ae into main May 16, 2026
1 check passed
@zacky1972 zacky1972 deleted the 46 branch May 16, 2026 00:03
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