From ca0b870315361ce4233395145137591d56d87fbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A2u=20Cao?= Date: Wed, 26 Apr 2023 15:17:11 +0200 Subject: [PATCH] Document CLI options in README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 358b75a..9f6c243 100644 --- a/README.md +++ b/README.md @@ -27,3 +27,21 @@ Clone the Git repository, then use npm scripts from its root directory. Or with debug output: npm run debug + +### CLI options + +Display progress bars: + + kredits-ipfs-pinner --progress + +Or with npm: + + npm start -- --progress + +Keep running and watch for new data/documents: + + kredits-ipfs-pinner --watch + +Multiple options at once: + + kredits-ipfs-pinner --progress --watch