Skip to content

Commit 74adbe6

Browse files
committed
Updated readme.
1 parent 135d70d commit 74adbe6

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.ja.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,11 @@ ABC0123456789abc ... XYZ
223223

224224
----
225225

226-
## Node.jsプロジェクトで使う
226+
## NPMパッケージプロジェクトで使う
227+
228+
注意: RelaxVersionerのNPMパッケージ対応は、機能が限定的です。
229+
NPMプロジェクト向けのバージョン管理を行う [screw-up](https://github.com/kekyo/screw-up/) をお勧めします。
230+
screw-upは、RelaxVersionerと同じバージョン探索アルゴリズムを使います。そして、NPMプロジェクトで使うことを前提に最適化されています。
227231

228232
CLIインターフェイスには、NPM (Node.js package manager) 向けの特別なオプションがあります。
229233
`package.json` ファイルが存在するディレクトリに移動して、以下のようにCLIを実行します:

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,11 @@ For example, in a CI/CD environment like GitHub Actions, you can apply versions
221221

222222
----
223223

224-
## Using with Node.js projects
224+
## Using with NPM package projects
225+
226+
NOTE: RelaxVersioner's NPM package support is limited in functionality.
227+
See also [screw-up](https://github.com/kekyo/screw-up/) for version control for NPM projects.
228+
screw-up uses the same version analysis algorithm as RelaxVersioner. It is optimized for use with NPM projects.
225229

226230
The CLI interface has special options for NPM (Node.js package manager).
227231
Change to the directory where the `package.json` file is located and run the CLI as follows:

0 commit comments

Comments
 (0)