Skip to content

Commit

Permalink
Update readmie with install steps and usage
Browse files Browse the repository at this point in the history
  • Loading branch information
trusz committed Feb 10, 2019
1 parent 72043f0 commit baad439
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,17 @@ A teminal UI to start individual services from docker-copose.yaml

The `rc` looks for `docker-compose.yaml` or `docker-compose.yml`

## Prerequisite

Currently in order to install you need to have go.

## Install

Clone the repo and execute the `make install` command.
Homebrew:

Or download the binary from the releases. The binary is for MacOS only.
```sh
brew install trusz/tap/rapid-compose
```

## Usage

Go into a folder where there is a `docker-compose` file and execute `rc`
Go into a folder where there is a `docker-compose` file and execute `rc`

By default, `rc` filters out every dependency services (`depends_on`) in order to show only the main ones.
However with the `-d` flag all services are shown.

0 comments on commit baad439

Please sign in to comment.