docs(cdk-common): add how to update library

- `README.md` and `README.ja.md` explain what we have to do when we update the library. issue codemonger-io#4
kikuomax · Jun 19, 2022 · 37585b0 · 37585b0
1 parent f75e3ed
commit 37585b0
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/cdk-common/README.ja.md b/cdk-common/README.ja.md
@@ -11,4 +11,14 @@
 - [`../cdk`](../cdk/README.ja.md)
 - [`../cdk-ops`](../cdk-ops/README.ja.md)
 
-このフォルダへの変更は上記のCDKスタックに反映されます。
+上記のCDKスタックは`dist`フォルダの中身をインポートします。
+
+### このライブラリを更新する
+
+このライブラリのコードを変更した際は、このフォルダで以下を実行しなければなりません。
+
+```sh
+npm run build
+```
+
+`dist`フォルダが更新されます。
diff --git a/cdk-common/README.md b/cdk-common/README.md
@@ -11,4 +11,14 @@ The following stacks link this library so far,
 - [`../cdk`](../cdk)
 - [`../cdk-ops`](../cdk-ops)
 
-Changes on this folder will be reflected to the above CDK stacks.
+The above CDK stacks import the contents of the `dist` folder.
+
+### Updating this library
+
+If you change the code of this library, you have to run the following in this folder,
+
+```sh
+npm run build
+```
+
+You will find the `dist` folder updated.