Skip to content

docs: note the library is on crates.io as code-search-please#54

Merged
amondnet merged 5 commits into
mainfrom
docs/readme-crates-io
Jun 22, 2026
Merged

docs: note the library is on crates.io as code-search-please#54
amondnet merged 5 commits into
mainfrom
docs/readme-crates-io

Conversation

@amondnet

@amondnet amondnet commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Reflects PR #53 / the crates.io bootstrap: the library is published as code-search-please (the short name csp was taken), with library name csp preserved.

  • Library section: explain the code-search-please package name + use csp::..., add a [dependencies] snippet.
  • Replace the bilingual "publishing to crates.io is planned" note with the live crates.io link.
  • README.md and README.ko.md kept in sync (per CLAUDE.md).

Summary by cubic

Update both READMEs to show the Rust crate is on crates.io as code-search-please while the library name remains csp (depend on code-search-please, import with use 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

  • Documentation
    • Updated the top badges to include crates.io version and Codecov coverage (alongside the existing npm badge), across the main and Korean READMEs.
    • Refreshed the “Library usage” guidance with clearer Rust crate publishing/naming details and updated TOML dependency snippets.
    • Updated crates.io status wording to reflect published availability and clarified that the npm package provides only a binary (no JavaScript API).

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.
@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: bdaadfb5-ca4a-42e7-bc34-2d09418d4b43

📥 Commits

Reviewing files that changed from the base of the PR and between 154a961 and 40d3be7.

📒 Files selected for processing (2)
  • README.ko.md
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Both README.md and README.ko.md add crates.io version and Codecov coverage badges to the header. The "Library usage" section is updated to state the crate is published on crates.io under code-search-please (library name csp), a Cargo.toml dependency snippet is added, and prior "publishing planned" language is replaced with current distribution details.

Changes

README Documentation Update

Layer / File(s) Summary
Badges, library usage, and publish status
README.md, README.ko.md
Adds crates.io version and Codecov coverage badges to the header. Updates the "Library usage" section to document the live crates.io publish name (code-search-please), adds a Cargo.toml dependency example (code-search-please = "0.1"), removes "publishing planned" guidance, and clarifies that the npm package provides only the csp binary with no JS API.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • pleaseai/code-search#44: Directly overlaps with this PR's changes to the README "Library usage" section, crates.io publishing guidance, and csp/code-search-please naming clarification.

Poem

🐇 A crate once "planned" now proudly ships,
On crates.io, a badge now flips!
code-search-please, the name to know,
While csp inside still runs the show.
The npm brings just a binary friend —
No JS API, just search to the end! 🦀

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change—documenting that the Rust library is published on crates.io under the package name 'code-search-please', which is a primary focus of the changeset alongside badge additions and documentation clarifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-crates-io

Comment @coderabbitai help to get the list of available commands and usage tips.

amondnet added 2 commits June 22, 2026 23:09
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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
Comment thread README.ko.md
@codecov

codecov Bot commented Jun 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@codacy-production

codacy-production Bot commented Jun 22, 2026

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

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)
@amondnet amondnet merged commit 3fa872b into main Jun 22, 2026
7 checks passed
@amondnet amondnet deleted the docs/readme-crates-io branch June 22, 2026 14:28
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