Skip to content

Improve examples README for HN launch#36

Merged
George-iam merged 1 commit intomainfrom
fix/examples-readme-20260325
Mar 25, 2026
Merged

Improve examples README for HN launch#36
George-iam merged 1 commit intomainfrom
fix/examples-readme-20260325

Conversation

@George-iam
Copy link
Copy Markdown
Contributor

Summary

  • Added one-liner after title explaining what AXME is
  • Added Related Repositories table linking to all 9 repos (axme, axme-spec, axme-docs, axme-cli, 5 SDK repos)
  • Integrated Alpha Access into Quick Start as step 0 (install CLI before using it)
  • Added brief explanations for Model B (ScenarioBundle) and Model A (Direct API) where they first appear
  • Added inline comment explaining AXME_CLI_SECRET_STORAGE=file and added it to Environment Variables table
  • Replaced all em dashes with regular dashes
  • Alpha Access section kept at bottom with expanded formatting (install command in code block)

Test plan

  • Verify all GitHub links resolve correctly
  • Confirm markdown renders properly on GitHub
  • Check that no em dashes remain

- Add one-liner explaining what AXME is after title
- Add Related Repositories table with links to all repos
- Integrate Alpha Access into Quick Start as step 0
- Add brief explanations for Model B (ScenarioBundle) and Model A (Direct API)
- Explain AXME_CLI_SECRET_STORAGE=file with inline comment and add to env vars table
- Replace em dashes with regular dashes throughout

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@George-iam George-iam merged commit cd75c57 into main Mar 25, 2026
1 check passed
@George-iam George-iam deleted the fix/examples-readme-20260325 branch March 25, 2026 13:33
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