Detailed informationa about usage
This commit is contained in:
parent
4d075c1925
commit
9591395aa4
24
README.md
24
README.md
|
@ -3,11 +3,16 @@
|
|||
## Installation
|
||||
|
||||
```shell
|
||||
pipx install git+https://git.goatpr0n.de/public/doxy.git
|
||||
pipx install git+https://github.com/jaypikay/doxy.git
|
||||
```
|
||||
|
||||
## Shell completion
|
||||
|
||||
### Service name completion
|
||||
|
||||
By enabling shell completion the service names are *TAB-Completted* when using the `control`
|
||||
command.
|
||||
|
||||
### Bash
|
||||
|
||||
#### Alternative 1
|
||||
|
@ -69,3 +74,20 @@ Commands:
|
|||
|
||||
To add parameters to an control argument use "--" to end the *Doxy* parameter evaluation and pass
|
||||
them to *docker-compose*.
|
||||
|
||||
## Examples
|
||||
|
||||
### List available services
|
||||
```shell
|
||||
$ doxy list
|
||||
Available Services
|
||||
├── service-1
|
||||
├── service-2
|
||||
├── other-service
|
||||
└── my-service-demo
|
||||
```
|
||||
|
||||
### Start a service and detach
|
||||
```shell
|
||||
$ doxy control other-service up -- -d
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue