Skip to content

Commit 2674cce

Browse files
committed
Update README.md
1 parent 448723c commit 2674cce

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

README.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,13 @@ CodeSandbox 上でコードを編集し、GitHub Actions から npm レジスト
55

66
## 利用方法
77

8-
まだ記述の途中。
9-
108
1. GitHub から import する(GitHubBox からは https://githubbox.com/hankei6km/my-starter-npm-cli-and-lib)
119
1. fork
12-
1. `package.json` `name` `version` `description` `license``LICENSE` あたりを新しいパッケージにあわせて変更
10+
1. `package.json` `LICENSE` 等を新しいパッケージにあわせて変更(付録にテンプレート)
1311
1. 新しい terminal を開き `$ npm run upgrade-interactive` 等でパッケージを更新
12+
1. ブラウザーをリロードする
1413

15-
これで 'npm run csb:test'(`jest --watchAll`) が terminal(「yarn start」タブ) 内で実行される
14+
これで terminal(「yarn start」タブ) 内で `jest --watchAll`(`csb:test`) が実行されるので、コードの編集等を行う
1615

1716
コマンドとしての実行を試す場合は `npm run start -- foo.txt` のように実行する。
1817

@@ -28,12 +27,29 @@ CodeSandbox 上でコードを編集し、GitHub Actions から npm レジスト
2827

2928
### npm publish
3029

31-
GitHub で Release を Publish するとビルド実行後に `npm pulish` される。
32-
33-
なお、`prepublishOnly` 等は定義されていないので、手動で `npm publish` 等を実行してもビルドはされないので注意。
34-
35-
36-
## 既知の問題
30+
GitHub で Release を Publish すると `npm pbulish` される。
31+
32+
なお、`prepublishOnly` 等は定義されていないので、手動で `npm publish` を実行してもビルドはされないので注意。
33+
34+
## 付録
35+
36+
`package.json` に記述する情報のテンプレート。`license` を変更したら `LICENSE` ファイルの変更も忘れずに。
37+
38+
```
39+
"name": "<package-name>",
40+
"version": "0.1.0",
41+
"description": "<description>",
42+
"author": "user <mail addr> (website url)",
43+
"license": "MIT",
44+
"repository": {
45+
"type": "git",
46+
"url": "git://github.com/<user>/<repository>.git"
47+
},
48+
"bugs": {
49+
"url": "https://github.com/<user>/<repository>/issues"
50+
},
51+
"keywords": []
52+
```
3753

3854
## 参考
3955

0 commit comments

Comments
 (0)