From 31233ec6a8c3c08e0395a1bcd2d7dcf4f7e701aa Mon Sep 17 00:00:00 2001 From: Felix Pankratz Date: Sun, 2 Jul 2023 16:32:02 +0200 Subject: [PATCH] cmdline help --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 48fe86e..2ee7d13 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,22 @@ Install the requirements first: pip install -r requirements.txt ``` +Check the help: + +``` +./npm-manifest-check.py -h +usage: npm-manifest-check [-h] [-b] package + +Check NPM packages for manifest mismatches + +positional arguments: + package name of the NPM package + +optional arguments: + -h, --help show this help message and exit + -b, --brief do not show detailed comparisons of mismatching values +``` + ### Single package To check a single package, pass the name of a package to the script as the first argument. Here, I'm using the package Darcy has helpfully provided: