@mai0313/go_template 0.1.14 → 0.1.19

package/README.md

@@ -3,6 +3,8 @@
 # Go Project Template
 
 [![Go](https://img.shields.io/badge/Go-1.24+-00ADD8?logo=go&logoColor=white)](https://go.dev/dl/)
+[![npm version](https://img.shields.io/npm/v/@mai0313/go_template?logo=npm&style=flat-square&color=CB3837)](https://www.npmjs.com/package/@mai0313/go_template)
+[![npm downloads](https://img.shields.io/npm/dt/@mai0313/go_template?logo=npm&style=flat-square)](https://www.npmjs.com/package/@mai0313/go_template)
 [![tests](https://github.com/Mai0313/go_template/actions/workflows/test.yml/badge.svg)](.github/workflows/test.yml)
 [![code-quality](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml/badge.svg)](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
@@ -50,11 +52,51 @@ Run the example CLI:
 ./build/go_template --version
 ```
 
-Use as a template:
+## Using as a Template
 
-1. Click Use this template to create your repository
-2. Replace module name in `go.mod` as needed
-3. Rename the command under `cmd/` if you want a different binary name
+**IMPORTANT**: This is a template, not a library. You must rename `go_template` to your project name.
+
+### Quick Setup
+
+1. Click **Use this template** to create your repository
+2. Clone your new repository
+3. Run the rename script or follow manual steps below
+
+### Manual Rename Steps
+
+**Required changes** (replace `{your_project}` with your actual project name):
+
+1. **Go Module**:
+
+    - Update `go.mod`: `module go_template` → `module {your_project}`
+    - Rename `cmd/go_template/` → `cmd/{your_project}/`
+    - Update imports in `cmd/{your_project}/main.go`
+    - Update `Makefile` LDFLAGS (lines 17-19) and `BIN_NAME` (line 23)
+
+2. **CLI Wrappers** (if using npm/PyPI distribution):
+
+    - Node.js: Update `cli/nodejs/package.json` and `cli/nodejs/bin/start.js`
+    - Python: Update `cli/python/pyproject.toml` and rename `cli/python/src/go_template/`
+
+3. **Docker**:
+
+    - Update `docker/Dockerfile` labels and binary paths
+    - Update `.devcontainer/Dockerfile` labels
+
+4. **Documentation**:
+
+    - Update badge URLs in `README.md`, `README.zh-CN.md`, `README.zh-TW.md`
+    - Update `.github/CODEOWNERS`
+
+**Verification**:
+
+```bash
+make clean && make build
+./build/{your_project} --version
+grep -r "go_template" --exclude-dir=.git --exclude-dir=build .
+```
+
+For detailed instructions, see [.github/copilot-instructions.md](.github/copilot-instructions.md).
 
 ## Project Structure
 

package/README.zh-CN.md

@@ -3,6 +3,8 @@
 # Go 项目模板
 
 [![Go](https://img.shields.io/badge/Go-1.24+-00ADD8?logo=go&logoColor=white)](https://go.dev/dl/)
+[![npm version](https://img.shields.io/npm/v/@mai0313/go_template?logo=npm&style=flat-square&color=CB3837)](https://www.npmjs.com/package/@mai0313/go_template)
+[![npm downloads](https://img.shields.io/npm/dt/@mai0313/go_template?logo=npm&style=flat-square)](https://www.npmjs.com/package/@mai0313/go_template)
 [![tests](https://github.com/Mai0313/go_template/actions/workflows/test.yml/badge.svg)](.github/workflows/test.yml)
 [![code-quality](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml/badge.svg)](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
@@ -50,11 +52,51 @@ make build-all        # 交叉编译常见 OS/ARCH
 ./build/go_template --version
 ```
 
-作为模板使用：
+## 作为模板使用
 
-1. 点击“使用此模板”创建你的仓库
-2. 按需修改 `go.mod` 的 module 名称
-3. 若需更换二进制名称，调整 `cmd/` 目录结构
+**重要提示**：这是一个模板，不是库。你必须将 `go_template` 重命名为你的项目名称。
+
+### 快速设置
+
+1. 点击 **使用此模板** 创建你的仓库
+2. 克隆你的新仓库
+3. 运行重命名脚本或按照下方手动步骤操作
+
+### 手动重命名步骤
+
+**必需修改**（将 `{your_project}` 替换为你的实际项目名称）：
+
+1. **Go 模块**：
+
+    - 更新 `go.mod`：`module go_template` → `module {your_project}`
+    - 重命名 `cmd/go_template/` → `cmd/{your_project}/`
+    - 更新 `cmd/{your_project}/main.go` 中的导入
+    - 更新 `Makefile` 的 LDFLAGS（第17-19行）和 `BIN_NAME`（第23行）
+
+2. **CLI 包装器**（如果使用 npm/PyPI 分发）：
+
+    - Node.js：更新 `cli/nodejs/package.json` 和 `cli/nodejs/bin/start.js`
+    - Python：更新 `cli/python/pyproject.toml` 并重命名 `cli/python/src/go_template/`
+
+3. **Docker**：
+
+    - 更新 `docker/Dockerfile` 标签和二进制路径
+    - 更新 `.devcontainer/Dockerfile` 标签
+
+4. **文档**：
+
+    - 更新 `README.md`、`README.zh-CN.md`、`README.zh-TW.md` 中的徽章 URL
+    - 更新 `.github/CODEOWNERS`
+
+**验证**：
+
+```bash
+make clean && make build
+./build/{your_project} --version
+grep -r "go_template" --exclude-dir=.git --exclude-dir=build .
+```
+
+详细说明请参见 [.github/copilot-instructions.md](.github/copilot-instructions.md)。
 
 ## 项目结构
 

package/README.zh-TW.md

@@ -3,6 +3,8 @@
 # Go 專案模板
 
 [![Go](https://img.shields.io/badge/Go-1.24+-00ADD8?logo=go&logoColor=white)](https://go.dev/dl/)
+[![npm version](https://img.shields.io/npm/v/@mai0313/go_template?logo=npm&style=flat-square&color=CB3837)](https://www.npmjs.com/package/@mai0313/go_template)
+[![npm downloads](https://img.shields.io/npm/dt/@mai0313/go_template?logo=npm&style=flat-square)](https://www.npmjs.com/package/@mai0313/go_template)
 [![tests](https://github.com/Mai0313/go_template/actions/workflows/test.yml/badge.svg)](.github/workflows/test.yml)
 [![code-quality](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml/badge.svg)](https://github.com/Mai0313/go_template/actions/workflows/code-quality-check.yml)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
@@ -50,11 +52,51 @@ make build-all        # 跨平台編譯常見 OS/ARCH
 ./build/go_template --version
 ```
 
-作為模板使用：
+## 作為模板使用
 
-1. 點擊「使用此模板」建立你的倉庫
-2. 視需求修改 `go.mod` 的 module 名稱
-3. 若要更換二進位名稱，請調整 `cmd/` 目錄結構
+**重要提示**：這是一個模板，不是函式庫。你必須將 `go_template` 重新命名為你的專案名稱。
+
+### 快速設定
+
+1. 點擊 **使用此模板** 建立你的倉庫
+2. 複製你的新倉庫
+3. 執行重新命名腳本或按照下方手動步驟操作
+
+### 手動重新命名步驟
+
+**必要修改**（將 `{your_project}` 替換為你的實際專案名稱）：
+
+1. **Go 模組**：
+
+    - 更新 `go.mod`：`module go_template` → `module {your_project}`
+    - 重新命名 `cmd/go_template/` → `cmd/{your_project}/`
+    - 更新 `cmd/{your_project}/main.go` 中的匯入
+    - 更新 `Makefile` 的 LDFLAGS（第17-19行）和 `BIN_NAME`（第23行）
+
+2. **CLI 包裝器**（如果使用 npm/PyPI 發佈）：
+
+    - Node.js：更新 `cli/nodejs/package.json` 和 `cli/nodejs/bin/start.js`
+    - Python：更新 `cli/python/pyproject.toml` 並重新命名 `cli/python/src/go_template/`
+
+3. **Docker**：
+
+    - 更新 `docker/Dockerfile` 標籤和二進位路徑
+    - 更新 `.devcontainer/Dockerfile` 標籤
+
+4. **文件**：
+
+    - 更新 `README.md`、`README.zh-CN.md`、`README.zh-TW.md` 中的徽章 URL
+    - 更新 `.github/CODEOWNERS`
+
+**驗證**：
+
+```bash
+make clean && make build
+./build/{your_project} --version
+grep -r "go_template" --exclude-dir=.git --exclude-dir=build .
+```
+
+詳細說明請參見 [.github/copilot-instructions.md](.github/copilot-instructions.md)。
 
 ## 專案結構
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mai0313/go_template",
-  "version": "0.1.14",
+  "version": "0.1.19",
   "description": "A production-ready Go project template to bootstrap new projects fast. It includes a clean Go module layout, Docker, and a complete CI/CD suite.",
   "author": "Wei Lee <mai@mai0313.com>",
   "license": "MIT",
@@ -40,6 +40,8 @@
   "files": [
     "bin/",
     "binaries/",
-    "README.md"
+    "README.md",
+    "README.zh-CN.md",
+    "README.zh-TW.md"
   ]
 }