]> zoso.dev Git - nano-pow.git/commitdiff
Document CLI in README.
authorChris Duncan <chris@zoso.dev>
Thu, 13 Mar 2025 00:56:25 +0000 (17:56 -0700)
committerChris Duncan <chris@zoso.dev>
Thu, 13 Mar 2025 00:56:25 +0000 (17:56 -0700)
README.md

index 0253ba7ba706875656f4702e4a2fdf767f751e73..308f086aafba3823b2c4c4eab14733217bb11af5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -83,6 +83,14 @@ const options = {
 const work = await NanoPow.search(hash, options)
 ```
 
+### Command Line
+NanoPow can be installed globally and executed from the command line. This is
+useful for systems without a graphical interface.
+```console
+$ npm -g i nano-pow
+$ nano-pow --help  # view command documentation
+```
+
 ## Notes
 The `work` field in a Nano transaction block contains an 8-byte nonce that
 satisfies the following equation: