@guojinpeng/dsh-cost-meter 0.1.3 → 0.1.5

package/README.md

@@ -21,16 +21,8 @@ dsh plugin --profile web add -w @guojinpeng/dsh-cost-meter
 Replace `web` with your profile name.
 If you used the old unscoped package, disable it before you install this package.
 
-If the npm package is not available, download the scoped package from
-[the latest GitHub Release](https://github.com/guojinpeng/dsh-cost-meter/releases/latest/download/guojinpeng-dsh-cost-meter.tgz).
-Run this command in the download directory:
-
-```powershell
-dsh plugin --profile web add -w ./guojinpeng-dsh-cost-meter.tgz
-```
-
-Restart DSH.
-Keep the downloaded file at the installation path.
+Install published versions from npm. npm provides the built package.
+GitHub contains the source code and release notes.
 
 ## Features
 
@@ -84,15 +76,16 @@ npm pack
 ```
 
 `npm pack` also runs the build. It creates `guojinpeng-dsh-cost-meter-<version>.tgz`.
-Install the generated file in your DSH profile. For version 0.1.3:
+Install the generated file in your DSH profile. For version 0.1.5:
 
 ```powershell
-dsh plugin --profile web add -w ./guojinpeng-dsh-cost-meter-0.1.3.tgz
+dsh plugin --profile web add -w ./guojinpeng-dsh-cost-meter-0.1.5.tgz
 ```
 
 Restart DSH and check the plugin. Repeat the build, package and install steps after changes.
 Tests use the global DSH installation. Set `DSH_RUNTIME_ROOT` to the DSH package directory if its location is different.
 Commit source files and `pnpm-lock.yaml`. Do not commit generated files or local configuration.
+See [the module guide](docs/architecture.md) for source boundaries and verification commands.
 
 ## Publish To npm
 
@@ -116,12 +109,12 @@ npm test
 npm run pack:release
 ```
 
-Check the package file list. `pack:release` creates the versioned npm tarball and
-an identical copy named `guojinpeng-dsh-cost-meter.tgz` for GitHub Releases.
-Commit and push the version change. Then publish the versioned tarball. For 0.1.3:
+Check the package file list. `pack:release` runs `npm pack` and creates the versioned
+npm tarball. Commit and push the version change. Then publish that tarball.
+For example, replace `<version>` with the new version number:
 
 ```powershell
-npm publish ./guojinpeng-dsh-cost-meter-0.1.3.tgz --access public --registry=https://registry.npmjs.org/
+npm publish ./guojinpeng-dsh-cost-meter-<version>.tgz --access public --registry=https://registry.npmjs.org/
 npm view @guojinpeng/dsh-cost-meter version --registry=https://registry.npmjs.org/
 ```
 
@@ -130,13 +123,14 @@ Each package version can be published only once.
 After npm publication succeeds, create the matching Git tag and GitHub Release:
 
 ```powershell
-git tag v0.1.3
-git push origin v0.1.3
-gh release create v0.1.3 ./guojinpeng-dsh-cost-meter.tgz --verify-tag --title "v0.1.3" --generate-notes --latest
+git tag v<version>
+git push origin v<version>
+gh release create v<version> --verify-tag --title "<version>" --generate-notes --latest
 ```
 
-Use the new version number for each release. Always upload the fixed-name asset
-to the latest release. Keep that asset name unchanged so the latest download URL works.
+Replace `<version>` before you run these commands. GitHub Releases contain release
+notes; uploading a tarball is optional. npm hosts the installation package.
+The plugin catalog links the npm package through its `repository` field.
 
 Users can then install the package:
 

package/README.zh-CN.md

@@ -21,16 +21,8 @@ dsh plugin --profile web add -w @guojinpeng/dsh-cost-meter
 将 `web` 替换为你使用的 profile 名称。
 如果已安装旧版无 scope 的插件，请先禁用旧版，再安装此插件。
 
-如果 npm 包尚不可用，请从
-[GitHub 最新版安装包](https://github.com/guojinpeng/dsh-cost-meter/releases/latest/download/guojinpeng-dsh-cost-meter.tgz)
-下载 scoped 安装包。在下载目录执行：
-
-```powershell
-dsh plugin --profile web add -w ./guojinpeng-dsh-cost-meter.tgz
-```
-
-安装后重启 DSH。
-请保留下载的安装包，不要改变其安装路径。
+通过 npm 安装已发布版本，npm 提供构建后的安装包。
+GitHub 用于保存源码和发布说明。
 
 ## 功能
 
@@ -84,15 +76,16 @@ npm pack
 ```
 
 `npm pack` 也会执行构建，生成 `guojinpeng-dsh-cost-meter-<版本号>.tgz`。
-将生成的文件安装到你的 DSH profile。以 0.1.3 为例：
+将生成的文件安装到你的 DSH profile。以 0.1.5 为例：
 
 ```powershell
-dsh plugin --profile web add -w ./guojinpeng-dsh-cost-meter-0.1.3.tgz
+dsh plugin --profile web add -w ./guojinpeng-dsh-cost-meter-0.1.5.tgz
 ```
 
 重启 DSH，检查插件。每次修改后，重新构建、打包并安装。
 测试使用全局安装的 DSH。如果安装位置不同，将 `DSH_RUNTIME_ROOT` 设置为 DSH 包目录。
 提交源码和 `pnpm-lock.yaml`。不要提交生成文件或本地配置。
+模块职责、依赖边界和验证命令见[模块维护说明](docs/architecture.md)。
 
 ## 发布到 npm
 
@@ -116,12 +109,12 @@ npm test
 npm run pack:release
 ```
 
-检查安装包的文件列表。`pack:release` 生成带版本号的 npm 安装包，
-并复制一份内容相同的 `guojinpeng-dsh-cost-meter.tgz`，用于 GitHub Release。
-提交并推送版本变更，然后发布带版本号的安装包。以 0.1.3 为例：
+检查安装包的文件列表。`pack:release` 执行 `npm pack`，生成带版本号的 npm 安装包。
+提交并推送版本变更，然后发布该安装包。
+执行前，将 `<version>` 替换为本次的新版本号：
 
 ```powershell
-npm publish ./guojinpeng-dsh-cost-meter-0.1.3.tgz --access public --registry=https://registry.npmjs.org/
+npm publish ./guojinpeng-dsh-cost-meter-<version>.tgz --access public --registry=https://registry.npmjs.org/
 npm view @guojinpeng/dsh-cost-meter version --registry=https://registry.npmjs.org/
 ```
 
@@ -130,13 +123,13 @@ npm view @guojinpeng/dsh-cost-meter version --registry=https://registry.npmjs.or
 npm 发布成功后，创建对应的 Git 标签和 GitHub Release：
 
 ```powershell
-git tag v0.1.3
-git push origin v0.1.3
-gh release create v0.1.3 ./guojinpeng-dsh-cost-meter.tgz --verify-tag --title "v0.1.3" --generate-notes --latest
+git tag v<version>
+git push origin v<version>
+gh release create v<version> --verify-tag --title "<version>" --generate-notes --latest
 ```
 
-每次发布都使用新的版本号，并将固定名称的安装包上传到最新 Release。
-保持附件名称不变，最新版下载链接才能持续可用。
+执行前替换 `<version>`。GitHub Release 用于发布说明，无需上传安装包。
+npm 托管安装包，插件市场通过 npm 包的 `repository` 字段关联仓库。
 
 发布后，用户可执行以下命令安装：