Update environment variable names in README

Environment variable names in the README file of `keystatic` package have been renamed for clarity and simplicity. For instance, `KEYSTATIC_PATH_STORAGE_KIND` is now `KEYSTATIC_STORAGE_KIND`. The variable changes apply to both `cloud` and `github` storage kinds.
This commit is contained in:
giancarlo
2024-04-19 13:15:32 +08:00
parent 27a717ad0f
commit 1b0c81a2b9

View File

@@ -17,17 +17,17 @@ KEYSTATIC_PATH=local # local, cloud, github
You can also use Keystatic Cloud or GitHub as the storage kind as remote storage. You can also use Keystatic Cloud or GitHub as the storage kind as remote storage.
If `KEYSTATIC_PATH_STORAGE_KIND` is set to `cloud`, the following environment variables are required: If `KEYSTATIC_STORAGE_KIND` is set to `cloud`, the following environment variables are required:
``` ```
KEYSTATIC_PATH_STORAGE_PROJECT=project-id KEYSTATIC_STORAGE_PROJECT=project-id
``` ```
If `KEYSTATIC_PATH_STORAGE_KIND` is set to `github`, the following environment variables are required: If `KEYSTATIC_STORAGE_KIND` is set to `github`, the following environment variables are required:
``` ```
KEYSTATIC_PATH_STORAGE_REPO=repo-name KEYSTATIC_STORAGE_REPO=repo-name
KEYSTATIC_PATH_STORAGE_BRANCH_PREFIX=branch-prefix KEYSTATIC_STORAGE_BRANCH_PREFIX=branch-prefix
``` ```
GitHub mode requires the installation of a GitHub app. GitHub mode requires the installation of a GitHub app.