Skip to content

Commit

Permalink
Add readme and changelog to corelib and prepare changeset
Browse files Browse the repository at this point in the history
  • Loading branch information
mbyrne00 committed Dec 14, 2023
1 parent af40b25 commit cdc36ec
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 1 deletion.
6 changes: 6 additions & 0 deletions .changeset/honest-apes-worry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@mondokit/gcp-core": patch
"@mondokit/core": patch
---

Split out core functionality that is not GCP-specific into a base core lib so we can re-use across other cloud providers going forward.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ these steps should save some time:
- Copy `package.json`, `tsconfig.json`, `tsconfig.prod.json`, `jest.config.json` from one of the existing packages
- Update `package.json` to match desired name, version, dependencies, etc
- Update `tsconfig.json` to match desired project references.
- Create file src/index.ts and export some constant
- Create file `src/index.ts` and export some constant
- Run `npm install` from root folder
- Run `npm run build` from project folder

Expand Down
2 changes: 2 additions & 0 deletions packages/core/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# @mondokit/core

6 changes: 6 additions & 0 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# MondoKit Core

Core library components that are not bound to any cloud provider. If you are using other libraries in `@mondokit`, then it is unlikely that you will need to depend on
this directly as it is likely referenced, and relevant utilities exported, via cloud-specific libraries such as `@mondokit/gcp-core`.

[Official documentation](https://mondokit.dev/packages/gcp-core.html)

0 comments on commit cdc36ec

Please sign in to comment.