From b0ab29bbb3ca78d2c50edf7db2a73a10f15e5175 Mon Sep 17 00:00:00 2001
From: gautaz <11046232+gautaz@users.noreply.github.com>
Date: Fri, 13 Aug 2021 09:47:30 +0200
Subject: [PATCH] update commands documentation

also:

* fix port options
* order the list alphabetically
---
 docs/README.md | 41 ++++++++++++++++++++++-------------------
 1 file changed, 22 insertions(+), 19 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index 7e19e25..4701090 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -17,31 +17,34 @@ npm install --save-dev docker-compose
 
 `docker-compose` current supports these commands:
 
-* `upAll(options)` - Builds, (re)creates, starts, and attaches to containers for all services - always uses the `-d` flag due to non interactive mode
-* `upMany(services, options)` - Builds, (re)creates, starts, and attaches to containers for the services specified in `services` - always uses the `-d` flag due to non interactive mode
-* `upOne(service, options)` - Builds, (re)creates, starts, and attaches to containers for a service specified in `service` - always uses the `-d` flag due to non interactive mode
-* `down(options)` - Stops containers and removes containers, networks, volumes, and images created by `up`
-* `kill(options)` - Force stop service containers
-* `stop(options)` - Stop running containers without removing them
-* `stopOne(service, options)` - Stops one container without removing it
-* `rm(options)` - Remove stopped service containers - always uses the `-f` flag due to non interactive mode
-* `exec(container, command, options)` - Exec `command` inside `container`, uses `-T` to properly handle stdin & stdout
-* `logs(services, options)` - Show logs of service(s). Use `options.follow` `true|false` to turn on `--follow` flag.
-* `run(service, command, options)` - Run a one-off `command` on a service, uses `-T` to properly handle stdin & stdout
 * `buildAll(options)` - Build or rebuild services
 * `buildMany(services, options)` - Build or rebuild services
 * `buildOne(service, options)` - Build or rebuild service
-* `pullMany(services, options)` - Pull service images specified
-* `pullOne(service, options)` - Pull a service image
-* `pullAll(options)` - Pull all service images
-* `restartAll(options)` - Restart all services
-* `restartMany(services, options)` - Restart services
-* `restartOne(service, options)` - Restart service
-* `ps(options)` - Lists containers information
 * `config(options)` - Validates configuration files and returns configuration yaml
 * `configServices(options)` - Returns list of services defined in configuration files
 * `configVolumes(options)` - Returns list of volumes defined in configuration files
-* `port(options)` - Returns the public port of the given service and internal port. 
+* `down(options)` - Stops containers and removes containers, networks, volumes, and images created by `up`
+* `exec(container, command, options)` - Exec `command` inside `container` - uses `-T` to properly handle stdin & stdout
+* `kill(options)` - Force stop service containers
+* `logs(services, options)` - Show logs of service(s) - use `options.follow` `true|false` to turn on `--follow` flag
+* `pauseOne(service, options)` - Pause the specified service
+* `port(service, containerPort, options)` - Returns the public port of the given service and internal port. 
+* `ps(options)` - Lists containers information
+* `pullAll(options)` - Pull all service images
+* `pullMany(services, options)` - Pull service images specified
+* `pullOne(service, options)` - Pull a service image
+* `restartAll(options)` - Restart all services
+* `restartMany(services, options)` - Restart services
+* `restartOne(service, options)` - Restart service
+* `rm(options, services)` - Remove stopped service containers - always uses the `-f` flag due to non interactive mode - `services` can optionally be used to select the containers to remove
+* `run(service, command, options)` - Run a one-off `command` on a service - uses `-T` to properly handle stdin & stdout
+* `stop(options)` - Stop running containers without removing them
+* `stopOne(service, options)` - Stops one container without removing it
+* `unpauseOne(service, options)` - Resume the specified service
+* `upAll(options)` - Builds, (re)creates, starts, and attaches to containers for all services - always uses the `-d` flag due to non interactive mode
+* `upMany(services, options)` - Builds, (re)creates, starts, and attaches to containers for the services specified in `services` - always uses the `-d` flag due to non interactive mode
+* `upOne(service, options)` - Builds, (re)creates, starts, and attaches to containers for a service specified in `service` - always uses the `-d` flag due to non interactive mode
+* `version(options)` - Show `docker-compose` version strings
 
 All commands return a `Promise({object})` with stdout and stderr strings and an exit code:
 ```javascript