From 9cc78305f07fbce1d85d22f4c7bb9562feb435be Mon Sep 17 00:00:00 2001 From: minsoo-web Date: Sun, 1 Mar 2026 20:22:52 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20rename=20hamkit=20=E2=86=92=20kit=20acr?= =?UTF-8?q?oss=20all=20markdown=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update all documentation references to match the remote repository name (hamsurang/kit), including URLs, titles, commands, and prose. Also adds marketplace add/install flow, plugin discovery commands, and update workflow to README (en/ko). Co-Authored-By: Claude Sonnet 4.6 --- .github/ISSUE_TEMPLATE/plugin-submission.md | 4 +- README.ko.md | 48 +++++++++++++++---- README.md | 48 +++++++++++++++---- docs/contributors/categories.md | 2 +- docs/contributors/contributing.md | 12 ++--- docs/contributors/plugin-spec.md | 2 +- docs/index.md | 2 +- .../plans/2026-03-01-repo-structure-design.md | 4 +- docs/plans/2026-03-01-repo-structure-plan.md | 44 ++++++++--------- docs/users/getting-started.md | 18 +++---- plugins/vitest/README.md | 2 +- 11 files changed, 125 insertions(+), 61 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/plugin-submission.md b/.github/ISSUE_TEMPLATE/plugin-submission.md index 8748576..806387b 100644 --- a/.github/ISSUE_TEMPLATE/plugin-submission.md +++ b/.github/ISSUE_TEMPLATE/plugin-submission.md @@ -1,6 +1,6 @@ --- name: Plugin Submission -about: Submit a new plugin to the hamkit marketplace +about: Submit a new plugin to the kit marketplace title: '[PLUGIN] your-plugin-name' labels: ['plugin-submission'] assignees: '' @@ -24,7 +24,7 @@ assignees: '' ## Installation & Usage Example ```bash -claude plugin install YOUR_PLUGIN_NAME@hamsurang/hamkit +claude plugin install YOUR_PLUGIN_NAME@hamsurang/kit ``` diff --git a/README.ko.md b/README.ko.md index 3f5a423..3c82d5a 100644 --- a/README.ko.md +++ b/README.ko.md @@ -1,4 +1,4 @@ -# hamkit +# kit > [Claude Code](https://claude.ai/code)를 위한 커뮤니티 플러그인 & 스킬 마켓플레이스 @@ -11,16 +11,48 @@ ## 플러그인 사용하기 -마켓플레이스에서 플러그인 설치: +### 1단계: kit 마켓플레이스 등록 ```bash -claude plugin install <플러그인-이름>@hamsurang/hamkit +claude plugin marketplace add https://github.com/hamsurang/kit ``` -또는 개별 스킬 설치: +### 2단계: 플러그인 탐색 ```bash -npx skills add hamsurang/hamkit +# 마켓플레이스의 전체 플러그인 목록 보기 +claude plugin list + +# 키워드로 검색 +claude plugin search <키워드> +``` + +### 3단계: 플러그인 설치 + +```bash +claude plugin install <플러그인-이름> +``` + +예시: + +```bash +claude plugin install vitest +``` + +### 플러그인 업데이트 + +```bash +# 특정 플러그인 업데이트 +claude plugin update <플러그인-이름> + +# 마켓플레이스 전체 갱신 +claude plugin marketplace update hamsurang/kit +``` + +마켓플레이스 등록 없이 스킬만 설치하려면: + +```bash +npx skills add hamsurang/kit ``` → [전체 설치 가이드](docs/users/getting-started.md) @@ -32,8 +64,8 @@ npx skills add hamsurang/hamkit 대화형으로 새 플러그인 스캐폴딩: ```bash -git clone https://github.com/hamsurang/hamkit -cd hamkit +git clone https://github.com/hamsurang/kit +cd kit bash scripts/scaffold-plugin.sh ``` @@ -53,7 +85,7 @@ bash scripts/scaffold-plugin.sh ## 보안 안내 -hamkit은 플러그인을 별도로 감사하거나 샌드박스 처리하지 않습니다. 특히 `.mcp.json`과 셸 커맨드가 포함된 플러그인은 설치 전 반드시 내용을 검토하세요. 신뢰할 수 있는 작성자의 플러그인만 설치하시기 바랍니다. +kit은 플러그인을 별도로 감사하거나 샌드박스 처리하지 않습니다. 특히 `.mcp.json`과 셸 커맨드가 포함된 플러그인은 설치 전 반드시 내용을 검토하세요. 신뢰할 수 있는 작성자의 플러그인만 설치하시기 바랍니다. ## 라이선스 diff --git a/README.md b/README.md index 6b07758..d7ab2e6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# hamkit +# kit > A community-driven plugin & skills marketplace for [Claude Code](https://claude.ai/code) @@ -11,16 +11,48 @@ ## Using Plugins -Install a plugin from the marketplace: +### Step 1: Add the kit marketplace ```bash -claude plugin install @hamsurang/hamkit +claude plugin marketplace add https://github.com/hamsurang/kit ``` -Or install individual skills: +### Step 2: Browse available plugins ```bash -npx skills add hamsurang/hamkit +# List all plugins from the marketplace +claude plugin list + +# Search by keyword +claude plugin search +``` + +### Step 3: Install a plugin + +```bash +claude plugin install +``` + +Example: + +```bash +claude plugin install vitest +``` + +### Updating plugins + +```bash +# Update a specific plugin +claude plugin update + +# Refresh all plugins from the marketplace +claude plugin marketplace update hamsurang/kit +``` + +Or install individual skills without adding the marketplace: + +```bash +npx skills add hamsurang/kit ``` → [Full installation guide](docs/users/getting-started.md) @@ -32,8 +64,8 @@ npx skills add hamsurang/hamkit Scaffold a new plugin interactively: ```bash -git clone https://github.com/hamsurang/hamkit -cd hamkit +git clone https://github.com/hamsurang/kit +cd kit bash scripts/scaffold-plugin.sh ``` @@ -53,7 +85,7 @@ bash scripts/scaffold-plugin.sh ## Security Notice -hamkit does not audit or sandbox plugins. Review any plugin — especially `.mcp.json` and shell commands — before installing. Only install from authors you trust. +kit does not audit or sandbox plugins. Review any plugin — especially `.mcp.json` and shell commands — before installing. Only install from authors you trust. ## License diff --git a/docs/contributors/categories.md b/docs/contributors/categories.md index 1941557..a716b69 100644 --- a/docs/contributors/categories.md +++ b/docs/contributors/categories.md @@ -1,6 +1,6 @@ # Plugin Categories -hamkit organizes plugins into 10 categories. Choose the category that best describes your plugin's primary purpose. +kit organizes plugins into 10 categories. Choose the category that best describes your plugin's primary purpose. ## Category Reference diff --git a/docs/contributors/contributing.md b/docs/contributors/contributing.md index 428071f..06dcd89 100644 --- a/docs/contributors/contributing.md +++ b/docs/contributors/contributing.md @@ -1,24 +1,24 @@ -# Contributing to hamkit +# Contributing to kit -hamkit is an open community marketplace. Anyone can submit a plugin — no gatekeeper, just quality checks. +kit is an open community marketplace. Anyone can submit a plugin — no gatekeeper, just quality checks. ## Ways to Contribute - **Submit a new plugin** — Share a plugin you built - **Improve an existing plugin** — Fix bugs, add features, improve docs -- **Report issues** — File bug reports or feature requests at [GitHub Issues](https://github.com/hamsurang/hamkit/issues) +- **Report issues** — File bug reports or feature requests at [GitHub Issues](https://github.com/hamsurang/kit/issues) - **Review PRs** — Help validate community plugins ## Submitting a New Plugin ### Step 1: Fork and clone the repo -1. Fork [hamsurang/hamkit](https://github.com/hamsurang/hamkit) on GitHub (click **Fork** in the top right) +1. Fork [hamsurang/kit](https://github.com/hamsurang/kit) on GitHub (click **Fork** in the top right) 2. Clone your fork: ```bash -git clone https://github.com//hamkit -cd hamkit +git clone https://github.com//kit +cd kit ``` ### Step 2: Scaffold your plugin diff --git a/docs/contributors/plugin-spec.md b/docs/contributors/plugin-spec.md index e5b651e..e2c74f2 100644 --- a/docs/contributors/plugin-spec.md +++ b/docs/contributors/plugin-spec.md @@ -1,6 +1,6 @@ # Plugin Specification -This document defines the format for hamkit plugins. All plugins must follow this specification to be accepted into the marketplace. +This document defines the format for kit plugins. All plugins must follow this specification to be accepted into the marketplace. ## Directory Structure diff --git a/docs/index.md b/docs/index.md index 9eb160e..626bae8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# hamkit Docs +# kit Docs ## For Plugin Users diff --git a/docs/plans/2026-03-01-repo-structure-design.md b/docs/plans/2026-03-01-repo-structure-design.md index 3810824..7634324 100644 --- a/docs/plans/2026-03-01-repo-structure-design.md +++ b/docs/plans/2026-03-01-repo-structure-design.md @@ -8,7 +8,7 @@ ## Problem Statement -The hamkit repository mixes user-facing content (how to install/use plugins) and contributor-facing content (how to build/submit plugins) in the same files, making the first-time experience unclear for both audiences. Additionally, there are known information inconsistencies (a `ham-starter` plugin referenced in README that does not exist). +The kit repository mixes user-facing content (how to install/use plugins) and contributor-facing content (how to build/submit plugins) in the same files, making the first-time experience unclear for both audiences. Additionally, there are known information inconsistencies (a `ham-starter` plugin referenced in README that does not exist). --- @@ -24,7 +24,7 @@ The hamkit repository mixes user-facing content (how to install/use plugins) and ## Directory Structure (After) ``` -hamkit/ +kit/ ├── README.md # Landing page — two clear paths ├── README.ko.md # Korean mirror, same structure ├── docs/ diff --git a/docs/plans/2026-03-01-repo-structure-plan.md b/docs/plans/2026-03-01-repo-structure-plan.md index 44e23cf..d4eaa1b 100644 --- a/docs/plans/2026-03-01-repo-structure-plan.md +++ b/docs/plans/2026-03-01-repo-structure-plan.md @@ -183,33 +183,33 @@ git commit -m "docs: move CONTRIBUTING.md to docs/contributors/contributing.md, **Step 1: Create the file with this exact content** ```markdown -# Getting Started with hamkit +# Getting Started with kit -hamkit is a community plugin & skills marketplace for [Claude Code](https://claude.ai/code). +kit is a community plugin & skills marketplace for [Claude Code](https://claude.ai/code). ## Installing a Plugin ```bash -claude plugin install @hamsurang/hamkit +claude plugin install @hamsurang/kit ``` Example: ```bash -claude plugin install vitest@hamsurang/hamkit +claude plugin install vitest@hamsurang/kit ``` ## Installing Skills Only (via npx) ```bash -# Install all hamkit skills -npx skills add hamsurang/hamkit +# Install all kit skills +npx skills add hamsurang/kit # Install a specific skill -npx skills add hamsurang/hamkit --skill vitest +npx skills add hamsurang/kit --skill vitest # Preview available skills without installing -npx skills add hamsurang/hamkit --list +npx skills add hamsurang/kit --list ``` ## Available Plugins @@ -218,7 +218,7 @@ See the [plugin directory](../../README.md#plugin--skills-directory) in README f ## Getting Help -- Browse [GitHub Issues](https://github.com/hamsurang/hamkit/issues) +- Browse [GitHub Issues](https://github.com/hamsurang/kit/issues) - Open a new issue if you encounter a bug or need help ``` @@ -246,7 +246,7 @@ git commit -m "docs: add docs/users/getting-started.md" **Step 1: Create the file with this exact content** ```markdown -# hamkit Docs +# kit Docs ## For Plugin Users @@ -282,7 +282,7 @@ git commit -m "docs: add docs/index.md as entry point" **Step 1: Replace the entire file with** ```markdown -# hamkit +# kit > A community-driven plugin & skills marketplace for [Claude Code](https://claude.ai/code) @@ -298,13 +298,13 @@ git commit -m "docs: add docs/index.md as entry point" Install a plugin from the marketplace: ```bash -claude plugin install @hamsurang/hamkit +claude plugin install @hamsurang/kit ``` Or install individual skills: ```bash -npx skills add hamsurang/hamkit +npx skills add hamsurang/kit ``` → [Full installation guide](docs/users/getting-started.md) @@ -316,8 +316,8 @@ npx skills add hamsurang/hamkit Scaffold a new plugin interactively: ```bash -git clone https://github.com/hamsurang/hamkit -cd hamkit +git clone https://github.com/hamsurang/kit +cd kit bash scripts/scaffold-plugin.sh ``` @@ -337,7 +337,7 @@ bash scripts/scaffold-plugin.sh ## Security Notice -hamkit does not audit or sandbox plugins. Review any plugin — especially `.mcp.json` and shell commands — before installing. Only install from authors you trust. +kit does not audit or sandbox plugins. Review any plugin — especially `.mcp.json` and shell commands — before installing. Only install from authors you trust. ## License @@ -383,7 +383,7 @@ Mirror the README.md structure exactly, translated to Korean. Key changes: - Match the same two-path (users / contributors) structure as README.md ```markdown -# hamkit +# kit > [Claude Code](https://claude.ai/code)를 위한 커뮤니티 플러그인 & 스킬 마켓플레이스 @@ -399,13 +399,13 @@ Mirror the README.md structure exactly, translated to Korean. Key changes: 마켓플레이스에서 플러그인 설치: ```bash -claude plugin install <플러그인-이름>@hamsurang/hamkit +claude plugin install <플러그인-이름>@hamsurang/kit ``` 또는 개별 스킬 설치: ```bash -npx skills add hamsurang/hamkit +npx skills add hamsurang/kit ``` → [전체 설치 가이드](docs/users/getting-started.md) @@ -417,8 +417,8 @@ npx skills add hamsurang/hamkit 대화형으로 새 플러그인 스캐폴딩: ```bash -git clone https://github.com/hamsurang/hamkit -cd hamkit +git clone https://github.com/hamsurang/kit +cd kit bash scripts/scaffold-plugin.sh ``` @@ -438,7 +438,7 @@ bash scripts/scaffold-plugin.sh ## 보안 안내 -hamkit은 플러그인을 별도로 감사하거나 샌드박스 처리하지 않습니다. 특히 `.mcp.json`과 셸 커맨드가 포함된 플러그인은 설치 전 반드시 내용을 검토하세요. 신뢰할 수 있는 작성자의 플러그인만 설치하시기 바랍니다. +kit은 플러그인을 별도로 감사하거나 샌드박스 처리하지 않습니다. 특히 `.mcp.json`과 셸 커맨드가 포함된 플러그인은 설치 전 반드시 내용을 검토하세요. 신뢰할 수 있는 작성자의 플러그인만 설치하시기 바랍니다. ## 라이선스 diff --git a/docs/users/getting-started.md b/docs/users/getting-started.md index 4d5d7d5..232ac38 100644 --- a/docs/users/getting-started.md +++ b/docs/users/getting-started.md @@ -1,30 +1,30 @@ -# Getting Started with hamkit +# Getting Started with kit -hamkit is a community plugin & skills marketplace for [Claude Code](https://claude.ai/code). +kit is a community plugin & skills marketplace for [Claude Code](https://claude.ai/code). ## Installing a Plugin ```bash -claude plugin install @hamsurang/hamkit +claude plugin install @hamsurang/kit ``` Example: ```bash -claude plugin install vitest@hamsurang/hamkit +claude plugin install vitest@hamsurang/kit ``` ## Installing Skills Only (via npx) ```bash -# Install all hamkit skills -npx skills add hamsurang/hamkit +# Install all kit skills +npx skills add hamsurang/kit # Install a specific skill -npx skills add hamsurang/hamkit --skill vitest +npx skills add hamsurang/kit --skill vitest # Preview available skills without installing -npx skills add hamsurang/hamkit --list +npx skills add hamsurang/kit --list ``` ## Available Plugins @@ -33,5 +33,5 @@ See the [plugin directory](../../README.md#plugin--skills-directory) in README f ## Getting Help -- Browse [GitHub Issues](https://github.com/hamsurang/hamkit/issues) +- Browse [GitHub Issues](https://github.com/hamsurang/kit/issues) - Open a new issue if you encounter a bug or need help diff --git a/plugins/vitest/README.md b/plugins/vitest/README.md index 31e7f74..077a0de 100644 --- a/plugins/vitest/README.md +++ b/plugins/vitest/README.md @@ -5,7 +5,7 @@ ## Installation ```bash -claude plugin install vitest@hamsurang/hamkit +claude plugin install vitest@hamsurang/kit ``` ## What This Plugin Does