diff --git a/README.md b/README.md index c83e59e..7a00b84 100644 --- a/README.md +++ b/README.md @@ -4,27 +4,21 @@ -* **Category**: -* **Status**: -* **Image**: -* **Healthcheck**: -* **Backups**: -* **Email**: -* **Tests**: -* **SSO**: +- **Category**: {{ .Category }} +- **Status**: {{ .Status }} +- **Image**: {{ .Image }} +- **Healthcheck**: {{ .Healthcheck }} +- **Backups**: {{ .Backups }} +- **Email**: {{ .Email }} +- **Tests**: {{ .Tests }} +- **SSO**: {{ .SSO }} -## Basic usage +## Quick start -1. Set up Docker Swarm and [`abra`] -2. Deploy [`coop-cloud/traefik`] -3. `abra app new ${REPO_NAME} --secrets` (optionally with `--pass` if you'd like - to save secrets in `pass`) -4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to - your Docker swarm box -5. `abra app YOURAPPDOMAIN deploy` -6. Open the configured domain in your browser to finish set-up +> For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech) -[`abra`]: https://git.coopcloud.tech/coop-cloud/abra -[`coop-cloud/traefik`]: https://git.coopcloud.tech/coop-cloud/traefik +1. `abra app new {{ .Name }} --secrets` +1. `abra app config ` +1. `abra app deploy `