From 8141f7804c7a91d2d4a2273f80248aa24891ff8d Mon Sep 17 00:00:00 2001 From: Minsu Lee Date: Mon, 22 Jun 2026 23:08:13 +0900 Subject: [PATCH 1/5] docs: note the library is published on crates.io as code-search-please 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. --- README.ko.md | 9 +++++++-- README.md | 9 +++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.ko.md b/README.ko.md index ee866eb..ca1628c 100644 --- a/README.ko.md +++ b/README.ko.md @@ -442,7 +442,12 @@ csp clear all # 인덱스 캐시와 savings 모두 삭제
라이브러리 사용 -`csp`는 Rust 라이브러리 크레이트(`csp`, [`crates/csp`](crates/csp))로도 사용할 수 있습니다. 자체 도구를 만들거나 검색을 Rust 코드에 직접 통합할 때 유용합니다. `CspIndex`(`from_path` / `from_git` / `search` / `find_related`)와 `ContentType` enum, 랭킹 파이프라인을 노출합니다. +`csp`는 Rust 라이브러리 크레이트로도 사용할 수 있습니다. 짧은 이름 `csp`가 이미 선점되어 [crates.io](https://crates.io/crates/code-search-please)에는 **`code-search-please`** 로 배포됩니다. 라이브러리 이름은 `csp` 그대로이므로 의존성은 `code-search-please`로 추가하되 코드에서는 `use csp::...`를 씁니다. `CspIndex`(`from_path` / `from_git` / `search` / `find_related`)와 `ContentType` enum, 랭킹 파이프라인을 노출합니다. + +```toml +[dependencies] +code-search-please = "0.1" +``` ```rust use std::path::Path; @@ -457,7 +462,7 @@ for r in &results { } ``` -> 크레이트의 [crates.io](https://crates.io) 배포는 예정되어 있습니다. 그 전까지는 path 또는 git 의존으로 사용하세요. (npm 패키지는 `csp` 바이너리를 런처 뒤에 담아 배포할 뿐, JavaScript API를 노출하지 않습니다.) +> 크레이트는 crates.io에 [`code-search-please`](https://crates.io/crates/code-search-please)로 배포되며 라이브러리 이름은 `csp`입니다. (npm 패키지는 `csp` 바이너리를 런처 뒤에 담아 배포할 뿐, JavaScript API를 노출하지 않습니다.)
diff --git a/README.md b/README.md index f9a76c5..b05c886 100644 --- a/README.md +++ b/README.md @@ -442,7 +442,12 @@ Explicit index paths written with `csp index -o ` are not part of the auto
Library usage -`csp` is also a Rust library crate (`csp`, in [`crates/csp`](crates/csp)), useful when building custom tooling or integrating search directly into your own Rust code. It exposes `CspIndex` with `from_path` / `from_git` / `search` / `find_related`, plus the `ContentType` enum and the ranking pipeline. +`csp` is also a Rust library crate, published on [crates.io](https://crates.io/crates/code-search-please) as **`code-search-please`** (the short name `csp` was already taken). The library name stays `csp`, so you depend on `code-search-please` but still write `use csp::...`. It exposes `CspIndex` with `from_path` / `from_git` / `search` / `find_related`, plus the `ContentType` enum and the ranking pipeline. + +```toml +[dependencies] +code-search-please = "0.1" +``` ```rust use std::path::Path; @@ -457,7 +462,7 @@ for r in &results { } ``` -> Publishing the crate to [crates.io](https://crates.io) is planned; until then, depend on it by path or git. (The npm package ships only the `csp` binary behind a launcher — it does not expose a JavaScript API.) +> The crate is published on crates.io as [`code-search-please`](https://crates.io/crates/code-search-please) with the library name `csp`. (The npm package ships only the `csp` binary behind a launcher — it does not expose a JavaScript API.)
From 577747112738637c826d06914974b57263862e9e Mon Sep 17 00:00:00 2001 From: Minsu Lee Date: Mon, 22 Jun 2026 23:09:02 +0900 Subject: [PATCH 2/5] docs: add crates.io version badge alongside npm 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. --- README.ko.md | 3 ++- README.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.ko.md b/README.ko.md index ca1628c..46fe9d7 100644 --- a/README.ko.md +++ b/README.ko.md @@ -6,7 +6,8 @@

- Package version + npm version + crates.io version License - MIT diff --git a/README.md b/README.md index b05c886..4ad8505 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@

- Package version + npm version + crates.io version License - MIT From 657472b7c2f093cf35384626af16645ef0c1af77 Mon Sep 17 00:00:00 2001 From: Minsu Lee Date: Mon, 22 Jun 2026 23:09:31 +0900 Subject: [PATCH 3/5] docs: add codecov coverage badge 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. --- README.ko.md | 1 + README.md | 1 + 2 files changed, 2 insertions(+) diff --git a/README.ko.md b/README.ko.md index 46fe9d7..75aa0f8 100644 --- a/README.ko.md +++ b/README.ko.md @@ -8,6 +8,7 @@

npm version crates.io version + Coverage License - MIT diff --git a/README.md b/README.md index 4ad8505..a902086 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@

npm version crates.io version + Coverage License - MIT From 154a9614f5cf614015f4f9c41d0117382b62466a Mon Sep 17 00:00:00 2001 From: Minsu Lee Date: Mon, 22 Jun 2026 23:12:25 +0900 Subject: [PATCH 4/5] docs: add Socket.dev supply-chain badge Add the Socket.dev badge for @pleaseai/csp alongside npm, crates.io, and coverage; README.md and README.ko.md kept in sync. --- README.ko.md | 1 + README.md | 1 + 2 files changed, 2 insertions(+) diff --git a/README.ko.md b/README.ko.md index 75aa0f8..b6d2877 100644 --- a/README.ko.md +++ b/README.ko.md @@ -9,6 +9,7 @@ npm version crates.io version Coverage + Socket Badge License - MIT diff --git a/README.md b/README.md index a902086..e05071a 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ npm version crates.io version Coverage + Socket Badge License - MIT From 40d3be75474ddd329b7c05b8855d4a5b348e8233 Mon Sep 17 00:00:00 2001 From: Minsu Lee Date: Mon, 22 Jun 2026 23:20:55 +0900 Subject: [PATCH 5/5] chore: apply AI code review suggestions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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) --- README.ko.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.ko.md b/README.ko.md index b6d2877..7bcdf1f 100644 --- a/README.ko.md +++ b/README.ko.md @@ -445,7 +445,7 @@ csp clear all # 인덱스 캐시와 savings 모두 삭제
라이브러리 사용 -`csp`는 Rust 라이브러리 크레이트로도 사용할 수 있습니다. 짧은 이름 `csp`가 이미 선점되어 [crates.io](https://crates.io/crates/code-search-please)에는 **`code-search-please`** 로 배포됩니다. 라이브러리 이름은 `csp` 그대로이므로 의존성은 `code-search-please`로 추가하되 코드에서는 `use csp::...`를 씁니다. `CspIndex`(`from_path` / `from_git` / `search` / `find_related`)와 `ContentType` enum, 랭킹 파이프라인을 노출합니다. +`csp`는 Rust 라이브러리 크레이트로도 사용할 수 있습니다. 짧은 이름 `csp`가 이미 선점되어 있어 crates.io에는 [**`code-search-please`**](https://crates.io/crates/code-search-please)로 배포됩니다. 라이브러리 이름은 `csp` 그대로이므로 의존성은 `code-search-please`로 추가하되 코드에서는 `use csp::...`를 씁니다. `CspIndex`(`from_path` / `from_git` / `search` / `find_related`)와 `ContentType` enum, 랭킹 파이프라인을 노출합니다. ```toml [dependencies] diff --git a/README.md b/README.md index e05071a..19ad260 100644 --- a/README.md +++ b/README.md @@ -445,7 +445,7 @@ Explicit index paths written with `csp index -o ` are not part of the auto
Library usage -`csp` is also a Rust library crate, published on [crates.io](https://crates.io/crates/code-search-please) as **`code-search-please`** (the short name `csp` was already taken). The library name stays `csp`, so you depend on `code-search-please` but still write `use csp::...`. It exposes `CspIndex` with `from_path` / `from_git` / `search` / `find_related`, plus the `ContentType` enum and the ranking pipeline. +`csp` is also a Rust library crate, published on crates.io as [**`code-search-please`**](https://crates.io/crates/code-search-please) (the short name `csp` was already taken). The library name stays `csp`, so you depend on `code-search-please` but still write `use csp::...`. It exposes `CspIndex` with `from_path` / `from_git` / `search` / `find_related`, plus the `ContentType` enum and the ranking pipeline. ```toml [dependencies]