Support version specifiers in GH action (#3265)

[etc/vim.git] / gallery / README.md

diff --git a/gallery/README.md b/gallery/README.md
index cd73db90bf4d5ec3f59da682767a16e33348b467..ea48e81a8432e2e066ce508ac715f2289bdd2ca1 100644 (file)
--- a/gallery/README.md
+++ b/gallery/README.md
@@ -1,24 +1,26 @@
 # Gallery
 
-Gallery is a script that automates process of applying different black versions to a
-selected PyPI package and seeing the results between black versions.
+Gallery is a script that automates the process of applying different _Black_ versions to
+a selected PyPI package and seeing the results between _Black_ versions.
 
 ## Build
 
 ```console
-$ [sudo] docker build -t black_gallery .
+$ docker build -t black_gallery .
 ```
 
 ## Run
 
 ```console
-$ sudo docker run -it -v /host/output:/output -v /host/input:/input black_gallery:latest [args]
+$ docker run -it -v /host/output:/output -v /host/input:/input black_gallery:latest [args]
 ```
 
 ```
-usage: gallery.py [-h] -p PYPI_PACKAGE -b BLACK_REPO [-v VERSION] [-i INPUT] [-o OUTPUT] [versions ...]
+usage: gallery.py [-h] (-p PYPI_PACKAGE | -t TOP_PACKAGES) [-b BLACK_REPO] [-v VERSION] [-w WORKERS] [-i INPUT] [-o OUTPUT]
+                  [versions [versions ...]]
 
-Black Gallery is a script that automates process of applying different black versions to a selected PyPI package and seeing the results between versions.
+Black Gallery is a script that automates the process of applying different Black versions to a selected PyPI package and
+seeing the results between versions.
 
 positional arguments:
   versions
@@ -27,12 +29,17 @@ optional arguments:
   -h, --help            show this help message and exit
   -p PYPI_PACKAGE, --pypi-package PYPI_PACKAGE
                         PyPI package to download.
+  -t TOP_PACKAGES, --top-packages TOP_PACKAGES
+                        Top n PyPI packages to download.
   -b BLACK_REPO, --black-repo BLACK_REPO
-                        Black's git repository.
+                        Black's Git repository.
   -v VERSION, --version VERSION
-                        Version for PyPI given pypi package.
+                        Version for given PyPI package. Will be discarded if used with -t option.
+  -w WORKERS, --workers WORKERS
+                        Maximum number of threads to download with at the same time. Will be discarded if used with -p
+                        option.
   -i INPUT, --input INPUT
-                        Input directory to read configurations.
+                        Input directory to read configuration.
   -o OUTPUT, --output OUTPUT
                         Output directory to download and put result artifacts.
 ```