759f682088073f1df2665abc541fb8d77ff9c4db

Author
Jayadeep K M <kmjayadeep@users.noreply.github.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

docker-compose: add aliases to README (#7226)

Diff

 1diff --git a/plugins/docker-compose/README.md b/plugins/docker-compose/README.md
 2index d3fcb29fef46c237de9f380d7c106d73caa7065b..07a87bc81f0e47d6a2390be60facd52eb8855cd1 100644
 3--- a/plugins/docker-compose/README.md
 4+++ b/plugins/docker-compose/README.md
 5@@ -1,4 +1,29 @@
 6-# Docker-compose plugin for oh my zsh
 7+# Docker-compose
 8 
 9-A copy of the completion script from the [docker-compose](https://github.com/docker/compose/blob/master/contrib/completion/zsh/_docker-compose) git repo.
10+This plugin provides completion for [docker-compose](https://docs.docker.com/compose/) as well as some
11+aliases for frequent docker-compose commands.
12 
13+To use it, add docker-compose to the plugins array of your zshrc file:
14+```
15+plugins=(... docker-compose)
16+```
17+
18+## Aliases
19+
20+| Alias     | Command                  | Description                                                      |
21+|-----------|--------------------------|------------------------------------------------------------------|
22+| dco       | `docker-compose`         | Docker-compose main command                                      |
23+| dcb       | `docker-compose build`   | Build containers                                                 |
24+| dce       | `docker-compose exec`    | Execute command inside a container                               |
25+| dcps      | `docker-compose ps`      | List containers                                                  |
26+| dcrestart | `docker-compose restart` | Restart container                                                |
27+| dcrm      | `docker-compose rm`      | Remove container                                                 |
28+| dcr       | `docker-compose run`     | Run a command in container                                       |
29+| dcstop    | `docker-compose stop`    | Stop a container                                                 |
30+| dcup      | `docker-compose up`      | Build, (re)create, start, and attach to containers for a service |
31+| dcupd     | `docker-compose up -d`   | Same as `dcup`, but starts as daemon                             |
32+| dcdn      | `docker-compose down`    | Stop and remove containers                                       |
33+| dcl       | `docker-compose logs`    | Show logs of container                                           |
34+| dclf      | `docker-compose logs -f` | Show logs and follow output                                      |
35+| dcpull    | `docker-compose pull`    | Pull image of a service                                          |
36+| dcstart   | `docker-compose start`   | Start a container                                                |