Clean up README and replace the stale Travis badge - #7
Merged
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replace the stale Travis badge with the live GitHub Actions badge and reorganize the README around installation, a quick start, and a concise API reference. Remove obsolete HTML anchors, repetitive argument labels and scattered release-note additions.
Correct constructor examples to pass required error parameters, integrate weighted increments into the main API, clarify approximate top-k behavior and serialization capacity options, and explain the error parameters without promising per-key percentage accuracy. Update the TypeScript dependency wording and retain migration details and contributor credit.
Validation: executed all five JavaScript examples against merged master; verified relative documentation/license links; rendered through GitHub's Markdown API; confirmed the Actions badge returns HTTP 200 and displays passing. Documentation-only change.