diff --git a/README.md b/README.md index 60790bc..0344325 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ # Maintenance -This is a simple maintenance page feel free to use it ! +This is a Cere maintenance page which can be setup and enabled for any UI application: -## How to install +![preview](https://raw.githubusercontent.com/Cerebellum-Network/maintenance-page/feature/add-readme/preview.jpg) -Simply download the index.html, modify its content, and copy it to your desired path. +## Add an application to Github actions -Additionally you can use the provided install.sh script. +1. Create an `-.yaml` workflow file separatelly for each environment. +2. In the `-.yaml` write your team name to show it on the maintenance page. +3. Add app secrets `_S3_BUCKET_NAME_DEV`, `_CF_DISTRIBUTION_ID_DEV` for this repository. +3. Create, approve and merge a PR into `dev-cere` branch. + +## Enable maintenance mode + +1. Run your application workflow in [GitHub Actions](https://github.com/Cerebellum-Network/maintenance-page/actions). + +## Disable maintenance mode + +1. Re-deploy your original application. \ No newline at end of file diff --git a/preview.jpg b/preview.jpg new file mode 100644 index 0000000..327950e Binary files /dev/null and b/preview.jpg differ