Merge pull request #100 from bluet/bluet-patch-fix-README.md

fix README.md
bluet · Aug 30, 2022 · e5563c4 · e5563c4
2 parents 5c27520 + 2b5e328
commit e5563c4
Showing 1 changed file with 14 additions and 58 deletions.
diff --git a/README.md b/README.md
@@ -94,21 +94,30 @@ To install last stable release from pypi:
 $ pip install proxybroker
 ```
 
-The latest development version can be installed directly from GitHub:
+To install the latest development version from GitHub:
 
 ``` {.sourceCode .bash}
 $ pip install -U git+https://github.com/bluet/proxybroker2.git
 ```
 
+### Use pre-built Docker image
+
+``` {.sourceCode .bash}
+$ docker pull bluet/proxybroker2
+```
+
 ### Build bundled one-file executable with pyinstaller
 
 #### Requirements
 
-Unix based systems
+*On UNIX-like systems (Linux / macOSX / BSD)*
 
 Install these tools
  - upx
- - objdump (this tool is usually in the bintools package)
+ - objdump (this tool is usually in the binutils package)
+ - `$ sudo apt install upx-ucl binutils` (On Ubuntu / Debian)
+
+#### Build
 
 ```
 pip install pyinstaller \
@@ -121,62 +130,8 @@ pip install pyinstaller \
 
 The executable is now in the build directory
 
-Windows
-
-```
-pip install pyinstaller \
-&& pip install . \
-&& mkdir -p build \
-&& cd build \
-&& pyinstaller --onefile --name proxybroker --add-data "../proxybroker/data;data" --workpath ./tmp --distpath . --clean ../py2exe_entrypoint.py \
-&& rm -rf tmp
-```
-
-
-### Use pre-built Docker image
-``` {.sourceCode .bash}
-$ docker run --rm bluet/proxybroker2 --help
-  usage: proxybroker [--max-conn MAX_CONN] [--max-tries MAX_TRIES]
-                     [--timeout SECONDS] [--judge JUDGES] [--provider PROVIDERS]
-                     [--verify-ssl]
-                     [--log [{NOTSET,DEBUG,INFO,WARNING,ERROR,CRITICAL}]]
-                     [--min-queue MINIMUM_PROXIES_IN_QUEUE]
-                     [--version] [--help]
-                     {find,grab,serve,update-geo} ...
-
-  Proxy [Finder | Checker | Server]
-
-  Commands:
-    These are common commands used in various situations
-
-    {find,grab,serve,update-geo}
-      find                Find and check proxies
-      grab                Find proxies without a check
-      serve               Run a local proxy server
-      update-geo          Download and use a detailed GeoIP database
-
-  Options:
-    --max-conn MAX_CONN   The maximum number of concurrent checks of proxies
-    --max-tries MAX_TRIES
-                          The maximum number of attempts to check a proxy
-    --timeout SECONDS, -t SECONDS
-                          Timeout of a request in seconds. The default value is
-                          8 seconds
-    --judge JUDGES        Urls of pages that show HTTP headers and IP address
-    --provider PROVIDERS  Urls of pages where to find proxies
-    --verify-ssl, -ssl    Flag indicating whether to check the SSL certificates
-    --min-queue MINIMUM_PROXIES_IN_QUEUE   The minimum number of proxies in the queue for checking connectivity
-    --log [{NOTSET,DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                          Logging level
-    --version, -v         Show program's version number and exit
-    --help, -h            Show this help message and exit
-
-  Run 'proxybroker <command> --help' for more information on a command.
-  Suggestions and bug reports are greatly appreciated:
-  <https://github.com/bluet/proxybroker2/issues>
-
+Usage
 -----
-```
 
 ### CLI Examples
 
@@ -422,6 +377,7 @@ Contributing
 -   Commit your changes: `git commit -am 'Add some feature'`
 -   Push to the branch: `git push origin my-new-feature`
 -   Submit a pull request!
+-   [Contributor workflow](https://github.com/bluet/proxybroker2/issues/93)
 
 License
 -------