From b655cf20bea383d24e725777a5fcef71378f0d91 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Tue, 2 Mar 2021 11:53:55 +0100 Subject: [PATCH] Make README less vague Closes https://git.autonomic.zone/coop-cloud/abra/issues/79. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 5a61835..5302d08 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ The cooperative cloud utility belt 🎩🐇 +`abra` is a command-line tool for managing your own [Co-op Cloud](https://cloud.autonomic.zone). It can provision new servers, create applications, deploy them, run backup and restore operations and a whole lot of other things. It is the go-to tool for day-to-day operations when managing a Co-op Cloud instance. + ## Documentation > [docs.cloud.autonomic.zone](https://docs.cloud.autonomic.zone/) @@ -16,3 +18,7 @@ The cooperative cloud utility belt 🎩🐇 ```sh curl https://install.abra.autonomic.zone | bash ``` + +## Hack + +It's written in Bash! Just open up the `abra` file and start hacking. Then you can run it in place with `./abra`. The command-line interface is generated via [docopt](http://docopt.org/). If you add arguments then you need to run `make docopt` ro regenerate the parser.