Skip to content

Commit 08751ac

Browse files
committed
docs: update README
- `0.3.0` → `0.4.0` - Requires `aws-cdk-lib` v2.201.0 or later
1 parent fb7a0d3 commit 08751ac

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

README.ja.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,14 @@
1515
このライブラリはNode.js v22.xで開発しました。
1616

1717
このライブラリはCDK**バージョン2** (CDK v2)向けに実装されており、CDKバージョン1には対応していません。
18+
また、[`aws-cdk-lib`](https://www.npmjs.com/package/aws-cdk-lib)はv2.201.0以降が必要です。
1819

1920
## インストール方法
2021

2122
このレポジトリを依存関係(`dependencies`)に追加してください。
2223

2324
```sh
24-
npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.3.0
25+
npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.4.0
2526
```
2627

2728
このライブラリはCDK v2プロジェクトで使用することを想定しており、以下のモジュールは`dependencies`ではなく`peerDependencies`に含んでいます。
@@ -33,7 +34,7 @@ CDK v2プロジェクトで使っている限り、これらを別途インス
3334
### GitHub Packagesからインストールする
3435

3536
`main`ブランチにコミットがプッシュされるたびに、開発者用パッケージがGitHub Packagesの管理するnpmレジストリにパブリッシュされます。
36-
開発者用パッケージのバージョンは次のリリースバージョンとハイフン(`-`)と短いコミットハッシュををつなげたもので表現されます。例、`0.3.0-abc1234` (`abc1234`はパッケージをビルドするのに使ったコミット(*スナップショット*)のコミットハッシュ)。
37+
開発者用パッケージのバージョンは次のリリースバージョンとハイフン(`-`)と短いコミットハッシュををつなげたもので表現されます。例、`0.4.0-abc1234` (`abc1234`はパッケージをビルドするのに使ったコミット(*スナップショット*)のコミットハッシュ)。
3738
開発者用パッケージは[こちら](https://github.com/codemonger-io/cdk-rest-api-with-spec/pkgs/npm/cdk-rest-api-with-spec)にあります。
3839

3940
#### GitHubパーソナルアクセストークンの設定
@@ -59,7 +60,7 @@ PATが手に入ったら以下の内容の`.npmrc`ファイルをホームディ
5960
これで以下のコマンドで開発者パッケージをインストールできます。
6061

6162
```sh
62-
npm install @codemonger-io/cdk-rest-api-with-spec@0.3.0-abc1234
63+
npm install @codemonger-io/cdk-rest-api-with-spec@0.4.0-abc1234
6364
```
6465

6566
`abc1234`はインストールしたい*スナップショット*の短いコミットハッシュに置き換えてください。

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,14 @@ You have to install [Node.js](https://nodejs.org/en/) v12 or later.
1515
I have developed this library with Node.js v22.x.
1616

1717
This library is implemented for the CDK **version 2** (CDK v2) and does not work with the CDK version 1.
18+
And [`aws-cdk-lib`](https://www.npmjs.com/package/aws-cdk-lib) v2.201.0 or later is required.
1819

1920
## How to install
2021

2122
Please add this repository to your dependencies.
2223

2324
```sh
24-
npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.3.0
25+
npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.4.0
2526
```
2627

2728
This library is supposed to be used in a CDK v2 project, so it does not include the following modules in the `dependencies` but does in the `peerDependencies`.
@@ -33,7 +34,7 @@ As long as you are working on a CDK v2 project, you should not have to separatel
3334
### Installing from GitHub Packages
3435

3536
Every time commits are pushed to the `main` branch, a developer package is published to the npm registry managed by GitHub Packages.
36-
The version of a developer package is represented by the next release version followed by a dash (`-`) plus the short commit hash; e.g., `0.3.0-abc1234` where `abc1234` is the short commit hash of the commit used to build the package (*snapshot*).
37+
The version of a developer package is represented by the next release version followed by a dash (`-`) plus the short commit hash; e.g., `0.4.0-abc1234` where `abc1234` is the short commit hash of the commit used to build the package (*snapshot*).
3738
You can find developer packages [here](https://github.com/codemonger-io/cdk-rest-api-with-spec/pkgs/npm/cdk-rest-api-with-spec).
3839

3940
#### Configuring GitHub personal access token
@@ -59,7 +60,7 @@ In the root directory of your project, please create a `.npmrc` file with the fo
5960
Then you can install a developer package with the following command,
6061

6162
```sh
62-
npm install @codemonger-io/cdk-rest-api-with-spec@0.3.0-abc1234
63+
npm install @codemonger-io/cdk-rest-api-with-spec@0.4.0-abc1234
6364
```
6465

6566
Please replace `abc1234` with the short commit hash of the *snapshot* you want to install.

0 commit comments

Comments
 (0)