docs: note the library is on crates.io as code-search-please#54
Conversation
The library crate is now on crates.io as code-search-please (the short name csp was taken); the library name stays csp, so users depend on code-search-please but write use csp::.... Add a [dependencies] snippet and update the bilingual 'publishing planned' note to reflect it's live.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughBoth ChangesREADME Documentation Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Add a crates.io version badge for code-search-please next to the existing npm badge (relabeled npm package -> npm); kept README.md and README.ko.md in sync.
Add a coverage badge linking to the codecov dashboard, alongside the npm and crates.io badges; README.md and README.ko.md kept in sync.
There was a problem hiding this comment.
Code Review
This pull request updates the English and Korean README files to document that the Rust library crate is published on crates.io as code-search-please and adds a TOML dependency snippet. The review feedback suggests improving link consistency in both files by linking the package name code-search-please directly instead of the platform name crates.io, and also proposes a minor phrasing improvement in the Korean translation.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Up to standards ✅🟢 Issues
|
Add the Socket.dev badge for @pleaseai/csp alongside npm, crates.io, and coverage; README.md and README.ko.md kept in sync.
Link the package name code-search-please (not the 'crates.io' text) in the Library section for consistency with the note below, and smooth the Korean phrasing (선점되어 -> 선점되어 있어). (gemini)
Reflects PR #53 / the crates.io bootstrap: the library is published as
code-search-please(the short namecspwas taken), with library namecsppreserved.code-search-pleasepackage name +use csp::..., add a[dependencies]snippet.Summary by cubic
Update both READMEs to show the Rust crate is on crates.io as
code-search-pleasewhile the library name remainscsp(depend oncode-search-please, import withuse csp::...).Adds a
[dependencies]snippet, replaces the “publishing planned” note with a live link, relabels the npm badge to “npm”, adds crates.io/Codecov/Socket.dev badges, and tweaks link text and Korean phrasing for clarity.Written for commit 40d3be7. Summary will update on new commits.
Summary by CodeRabbit