Skip to content

Commit

Permalink
docs(cdk-common): add README
Browse files Browse the repository at this point in the history
- `README.md` briefly explains this library.

issue codemonger-io#4
  • Loading branch information
kikuomax committed Jun 17, 2022
1 parent 3ee5e5a commit ecccc90
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
14 changes: 14 additions & 0 deletions cdk-common/README.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[English](./README.md) / 日本語

# CDKスタックの共通ライブラリ

このレポジトリのCDKスタックで共有される型や関数を提供します。

## このライブラリの使い方

このライブラリはこのレポジトリのCDKスタックからローカルにリンクすることを意図しています。
今のところ以下のスタックがこのライブラリをリンクしています。
- [`../cdk`](../cdk/README.ja.md)
- [`../cdk-ops`](../cdk-ops/README.ja.md)

このフォルダへの変更は上記のCDKスタックに反映されます。
14 changes: 14 additions & 0 deletions cdk-common/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
English / [日本語](./README.ja.md)

# Common library for CDK stacks

Provides types and functions shared among CDK stacks in this repository.

## How to use this library

This library is inteded to be locally linked from CDK stacks in this repository.
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.

0 comments on commit ecccc90

Please sign in to comment.