Merge pull request #73 from bcgov/docs/graphemes-api-readme

Docs/graphemes api readme

Author: ty2k

.github/workflows/graphemes_api_build.yaml

@@ -1,9 +1,10 @@
 ---
 name: Build and push graphemes-api image
 
-# Limit GITHUB_TOKEN permissions to only read repo contents.
+# Limit GITHUB_TOKEN permissions
 permissions:
-  contents: read
+  contents: read # Read the repo contents
+  packages: write # Push built image to GitHub Container Registry
 
 on:
   push:

graphemes-api/README.md

@@ -1,3 +1,7 @@
 # graphemes-api
 
 This folder contains an in-development Express.js API for graphemes/confusables.
+
+## Build
+
+See [graphemes_api_build.yaml](../.github/workflows/graphemes_api_build.yaml).