Skip to content

docs(readme): lead with offline and mirror support, compress the API - #13

Merged
m1ngsama merged 1 commit into
mainfrom
docs/readme-focus
Sep 28, 2026
Merged

m1ngsama merged 1 commit into
mainfrom
docs/readme-focus

Conversation

@m1ngsama

Copy link
Copy Markdown
Member

The README called the package a GitHub client and buried its cache, mirror, and search behind nine API sections.

  • The opening names listing, reading, searching, the verified cache, and the mirror.
  • The usage example shows the production setup with mirror and store.
  • One table replaces the per-method sections, and it adds the missing parseDoc export. The README drops from 107 to 72 lines.

@m1ngsama
m1ngsama merged commit 7b7d1fb into main Sep 28, 2026
5 checks passed
@m1ngsama
m1ngsama deleted the docs/readme-focus branch September 28, 2026 05:19
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