Skip to content
This repository was archived by the owner on Apr 4, 2023. It is now read-only.

Commit 5b71a06

Browse files
committed
Updated README
1 parent 1f89ea1 commit 5b71a06

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# bach - Basic API (Compose) Handler
22

3-
Bach is a Go-based application which uses the Compose API to provide the ability
3+
Bach is an application which uses the Compose API to provide the ability
44
to create, monitor and delete Compose databases.
55

66
To use, an environment variable - COMPOSEAPITOKEN must be set. This token value
77
can be obtained from the Compose console's Account view.
88

9-
Further details to follow.
9+
Where a command needs a parameter to identify a deployment, Bach can use either
10+
the deployment ID or the deployment name.
11+
12+
Bach is written in Go and uses the GoComposeAPI package for API requests.
1013

1114
## Bach commands
1215

@@ -30,6 +33,7 @@ Available Commands:
3033
deprovision Deprovision a deployment
3134
details Show details for a deployment
3235
help Help about any command
36+
list List deployments attached to account
3337
recipe Show details of a recipe
3438
recipes Show Recipes related to deployment
3539
scale Show scale information for a deployment

0 commit comments

Comments
 (0)