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

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
codepope committed Jun 6, 2018
1 parent 1f89ea1 commit 5b71a06
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# bach - Basic API (Compose) Handler

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

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

Further details to follow.
Where a command needs a parameter to identify a deployment, Bach can use either
the deployment ID or the deployment name.

Bach is written in Go and uses the GoComposeAPI package for API requests.

## Bach commands

Expand All @@ -30,6 +33,7 @@ Available Commands:
deprovision Deprovision a deployment
details Show details for a deployment
help Help about any command
list List deployments attached to account
recipe Show details of a recipe
recipes Show Recipes related to deployment
scale Show scale information for a deployment
Expand Down

0 comments on commit 5b71a06

Please sign in to comment.