docs(Update readme and branch): Update readme linking API docs, updat…

…e branch to main
jmiumv · Feb 19, 2023 · cd9ccbe · cd9ccbe
1 parent b593a18
commit cd9ccbe
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 13 deletions.
diff --git a/.gitattributes b/.gitattributes
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/.github/workflows/upgrade-master.yml → .github/workflows/upgrade-main.yml b/.github/workflows/upgrade-master.yml → .github/workflows/upgrade-main.yml
diff --git a/.gitignore b/.gitignore
diff --git a/.projen/files.json b/.projen/files.json
diff --git a/.projen/tasks.json b/.projen/tasks.json
diff --git a/.projenrc.js b/.projenrc.js
@@ -1,6 +1,6 @@
 const { awscdk } = require('projen');
 const project = new awscdk.AwsCdkConstructLibrary({
-  defaultReleaseBranch: 'master',
+  defaultReleaseBranch: 'main',
   author: 'JNE',
   cdkVersion: '2.1.0',
   name: 'cdk-appconfig',

diff --git a/README.md b/README.md
@@ -1,12 +1,16 @@
 # cdk-appconfig
 
-## Hello ! 
+## Motivation ! 
 This simple project was inspired from [this stackoverflow question](https://stackoverflow.com/questions/67579029/aws-cdk-lambda-appconfig-typescript-example-please/74724158#74724158), where I shared [this answer](https://stackoverflow.com/a/74724158). 
 
 When I [read docs on the AppConfig construct library](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig-readme.html), I soon realized that it was ripe for L2 and L3 constructs. Hence this library. 
 
 The library is published under the following names:
 
+## API Documentation
+* Please refer projen autogenerated API docs [here](API.md)
+
+## Releases
 |Language|Repository
 |--------|-----------
 |JavaScript/TypeScript|[cdk-appconfig](https://www.npmjs.com/package/cdk-appconfig)