docs: add link to generated docs in each package README

jackdbd · May 21, 2022 · 435d090 · 435d090
1 parent 79b04c8
commit 435d090
Show file tree

Hide file tree

Showing 16 changed files with 74 additions and 246 deletions.
diff --git a/assets/templates/library/README.md b/assets/templates/library/README.md
@@ -7,3 +7,7 @@ Description...
 ```sh
 npm install @jackdbd/PACKAGE_NAME
 ```
+
+## API
+
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/PACKAGE_NAME/)
diff --git a/docs/README.md b/docs/README.md
@@ -1,14 +1,16 @@
 # docs
 
-In these docs:
-
-- `prj-kitchen-sink` will be referenced as `GCP_PROJECT_ID`
-- `personal` will be referenced as `CUSTOMER`
-- `prod` will be referenced as `ENVIRONMENT`
-
-Documents for Google Cloud Platform:
-
-- [intructions for Artifact Registry](./artifact-registry.md)
-- [intructions for IAM project policy](./iam-project-policy.md)
-- [intructions for Secret Manager](./secret-manager.md)
-- [intructions for Service Accounts](./service-accounts.md)
+- [checks](./checks/index.html)
+- [cloud-scheduler-utils](./cloud-scheduler-utils/)
+- [fattureincloud-client](./fattureincloud-client/)
+- [firestore-utils](./firestore-utils/)
+- [hapi-healthcheck-plugin](./hapi-healthcheck-plugin/)
+- [hapi-ip-whitelist-plugin](./hapi-ip-whitelist-plugin/)
+- [keap-client](./keap-client/)
+- [notifications](./notifications/)
+- [schemas](./schemas/)
+- [secret-manager-utils](./secret-manager-utils/)
+- [sqlite-utils](./sqlite-utils/)
+- [stripe-utils](./stripe-utils/)
+- [telegram-text-messages](./telegram-text-messages/)
+- [utils](./utils/)
diff --git a/packages/checks/README.md b/packages/checks/README.md
@@ -7,3 +7,7 @@ Functions to check inputs (i.e. predicates).
 ```sh
 npm install @jackdbd/checks
 ```
+
+## API
+
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/checks/)
diff --git a/packages/cloud-scheduler-utils/README.md b/packages/cloud-scheduler-utils/README.md
@@ -7,3 +7,7 @@ Utility functions to work with Cloud Sheduler.
 ```sh
 npm install @jackdbd/cloud-scheduler-utils
 ```
+
+## API
+
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/cloud-scheduler-utils/)
diff --git a/packages/fattureincloud-client/README.md b/packages/fattureincloud-client/README.md
@@ -2,34 +2,12 @@
 
 Unofficial API client for [FattureInCloud](https://www.fattureincloud.it/) with auto-pagination and optional rate-limits.
 
-## Build
-
-Build this library:
-
-```sh
-npm run build -w packages/fattureincloud-client
-```
-
-## Test
-
-```sh
-npm run test -w packages/fattureincloud-client
-```
-
-## Publish
-
-### Artifact Registry
+## Installation
 
 ```sh
-npm run publish:artifact-registry -w packages/fattureincloud-client
+npm install @jackdbd/fattureincloud-client
 ```
 
-Check that the correct version of this package is now published on Artifact Registry:
+## API
 
-```sh
-gcloud artifacts versions list \
-  --project $GCP_PROJECT_ID \
-  --repository $ARTIFACT_REGISTRY_NPM_REPOSITORY_ID \
-  --location $ARTIFACT_REGISTRY_NPM_REPOSITORY_LOCATION \
-  --package @jackdbd/fattureincloud-client
-```
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/fattureincloud-client/)
diff --git a/packages/firestore-utils/README.md b/packages/firestore-utils/README.md
@@ -2,34 +2,12 @@
 
 Utility functions to work with Firestore.
 
-## Build
-
-Build this library:
-
-```sh
-npm run build -w packages/firestore-utils
-```
-
-## Test
-
-```sh
-npm run test -w packages/firestore-utils
-```
-
-## Publish
-
-### Artifact Registry
+## Installation
 
 ```sh
-npm run publish:artifact-registry -w packages/firestore-utils
+npm install @jackdbd/firestore-utils
 ```
 
-Check that the correct version of this package is now published on Artifact Registry:
+## API
 
-```sh
-gcloud artifacts versions list \
-  --project $GCP_PROJECT_ID \
-  --repository $ARTIFACT_REGISTRY_NPM_REPOSITORY_ID \
-  --location $ARTIFACT_REGISTRY_NPM_REPOSITORY_LOCATION \
-  --package @jackdbd/firestore-utils
-```
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/firestore-utils/)
diff --git a/packages/hapi-healthcheck-plugin/README.md b/packages/hapi-healthcheck-plugin/README.md
@@ -7,3 +7,7 @@ Hapi plugin for a healthcheck.
 ```sh
 npm install @jackdbd/hapi-healthcheck-plugin
 ```
+
+## API
+
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/hapi-healthcheck-plugin/)
diff --git a/packages/hapi-ip-whitelist-plugin/README.md b/packages/hapi-ip-whitelist-plugin/README.md
@@ -7,3 +7,7 @@ Hapi plugin to allow an IP whitelist.
 ```sh
 npm install @jackdbd/hapi-ip-whitelist-plugin
 ```
+
+## API
+
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/hapi-ip-whitelist-plugin/)
diff --git a/packages/keap-client/README.md b/packages/keap-client/README.md
@@ -2,34 +2,12 @@
 
 Unofficial API client for [Keap (aka Infusionsoft)](https://keap.com/).
 
-## Build
-
-Build this library:
-
-```sh
-npm run build -w packages/keap-client
-```
-
-## Test
-
-```sh
-npm run test -w packages/keap-client
-```
-
-## Publish
-
-### Artifact Registry
+## Installation
 
 ```sh
-npm run publish:artifact-registry -w packages/keap-client
+npm install @jackdbd/keap-client
 ```
 
-Check that the correct version of this package is now published on Artifact Registry:
+## API
 
-```sh
-gcloud artifacts versions list \
-  --project $GCP_PROJECT_ID \
-  --repository $ARTIFACT_REGISTRY_NPM_REPOSITORY_ID \
-  --location $ARTIFACT_REGISTRY_NPM_REPOSITORY_LOCATION \
-  --package @jackdbd/keap-client
-```
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/keap-client/)
diff --git a/packages/notifications/README.md b/packages/notifications/README.md
@@ -2,34 +2,12 @@
 
 Functions used to send notifications to various channels (Telegram, email, etc).
 
-## Build
-
-Build this library:
-
-```sh
-npm run build -w packages/notifications
-```
-
-## Test
-
-```sh
-npm run test -w packages/notifications
-```
-
-## Publish
-
-### Artifact Registry
+## Installation
 
 ```sh
-npm run publish:artifact-registry -w packages/notifications
+npm install @jackdbd/notifications
 ```
 
-Check that the correct version of this package is now published on Artifact Registry:
+## API
 
-```sh
-gcloud artifacts versions list \
-  --project $GCP_PROJECT_ID \
-  --repository $ARTIFACT_REGISTRY_NPM_REPOSITORY_ID \
-  --location $ARTIFACT_REGISTRY_NPM_REPOSITORY_LOCATION \
-  --package @jackdbd/notifications
-```
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/notifications/)
diff --git a/packages/schemas/README.md b/packages/schemas/README.md
@@ -2,34 +2,12 @@
 
 JSON schemas with [Ajv](https://ajv.js.org/).
 
-## Build
-
-Build this library:
-
-```sh
-npm run build -w packages/schemas
-```
-
-## Test
-
-```sh
-npm run test -w packages/schemas
-```
-
-## Publish
-
-### Artifact Registry
+## Installation
 
 ```sh
-npm run publish:artifact-registry -w packages/schemas
+npm install @jackdbd/schemas
 ```
 
-Check that the correct version of this package is now published on Artifact Registry:
+## API
 
-```sh
-gcloud artifacts versions list \
-  --project $GCP_PROJECT_ID \
-  --repository $ARTIFACT_REGISTRY_NPM_REPOSITORY_ID \
-  --location $ARTIFACT_REGISTRY_NPM_REPOSITORY_LOCATION \
-  --package @jackdbd/schemas
-```
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/schemas/)
diff --git a/packages/secret-manager-utils/README.md b/packages/secret-manager-utils/README.md
@@ -2,34 +2,12 @@
 
 Utilities for Secret Manager.
 
-## Build
-
-Build this library:
-
-```sh
-npm run build -w packages/secret-manager-utils
-```
-
-## Test
-
-```sh
-npm run test -w packages/secret-manager-utils
-```
-
-## Publish
-
-### Artifact Registry
+## Installation
 
 ```sh
-npm run publish:artifact-registry -w packages/secret-manager-utils
+npm install @jackdbd/secret-manager-utils
 ```
 
-Check that the correct version of this package is now published on Artifact Registry:
+## API
 
-```sh
-gcloud artifacts versions list \
-  --project $GCP_PROJECT_ID \
-  --repository $ARTIFACT_REGISTRY_NPM_REPOSITORY_ID \
-  --location $ARTIFACT_REGISTRY_NPM_REPOSITORY_LOCATION \
-  --package @jackdbd/secret-manager-utils
-```
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/secret-manager-utils/)
diff --git a/packages/sqlite-utils/README.md b/packages/sqlite-utils/README.md
@@ -2,34 +2,12 @@
 
 Utility functions to work with SQLite.
 
-## Build
-
-Build this library:
-
-```sh
-npm run build -w packages/sqlite-utils
-```
-
-## Test
-
-```sh
-npm run test -w packages/sqlite-utils
-```
-
-## Publish
-
-### Artifact Registry
+## Installation
 
 ```sh
-npm run publish:artifact-registry -w packages/sqlite-utils
+npm install @jackdbd/sqlite-utils
 ```
 
-Check that the correct version of this package is now published on Artifact Registry:
+## API
 
-```sh
-gcloud artifacts versions list \
-  --project $GCP_PROJECT_ID \
-  --repository $ARTIFACT_REGISTRY_NPM_REPOSITORY_ID \
-  --location $ARTIFACT_REGISTRY_NPM_REPOSITORY_LOCATION \
-  --package @jackdbd/sqlite-utils
-```
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/sqlite-utils/)
diff --git a/packages/stripe-utils/README.md b/packages/stripe-utils/README.md
@@ -2,34 +2,12 @@
 
 Utility functions to work with Stripe.
 
-## Build
-
-Build this library:
-
-```sh
-npm run build -w packages/stripe-utils
-```
-
-## Test
-
-```sh
-npm run test -w packages/stripe-utils
-```
-
-## Publish
-
-### Artifact Registry
+## Installation
 
 ```sh
-npm run publish:artifact-registry -w packages/stripe-utils
+npm install @jackdbd/stripe-utils
 ```
 
-Check that the correct version of this package is now published on Artifact Registry:
+## API
 
-```sh
-gcloud artifacts versions list \
-  --project $GCP_PROJECT_ID \
-  --repository $ARTIFACT_REGISTRY_NPM_REPOSITORY_ID \
-  --location $ARTIFACT_REGISTRY_NPM_REPOSITORY_LOCATION \
-  --package @jackdbd/stripe-utils
-```
+[API docs generated with TypeDoc](https://jackdbd.github.io/calderone/stripe-utils/)
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,3 +7,7 @@ Description... @@
     ```sh
     npm install @jackdbd/PACKAGE_NAME
     ```
+    ## API
+    [API docs generated with TypeDoc](https://jackdbd.github.io/calderone/PACKAGE_NAME/)