Skip to content

Polish README for launch visitors#19

Merged
duriantaco merged 1 commit into
mainfrom
docs/show-hn-readme-polish
Apr 30, 2026
Merged

Polish README for launch visitors#19
duriantaco merged 1 commit into
mainfrom
docs/show-hn-readme-polish

Conversation

@duriantaco

Copy link
Copy Markdown
Owner

Summary

  • Move install guidance above the long usage reference so new visitors can try jonq immediately.
  • Tighten the opening pitch around inspecting unfamiliar JSON, readable SQL-like queries, and generated jq.
  • Surface typo repair earlier in the README, before the detailed feature reference.

Validation

  • python -m pre_commit run --all-files
  • LC_ALL=C LANG=C python -m sphinx -b html docs/source /tmp/jonq-docs-readme-polish
  • Manual typo-repair check: python -m jonq tests/json_test_files/simple.json "select nme"

@duriantaco duriantaco merged commit c67073a into main Apr 30, 2026
3 checks passed
@duriantaco duriantaco deleted the docs/show-hn-readme-polish branch April 30, 2026 03:01
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