docs: remove optional keyfile

[crowdnode.js/.git] / cli / README.md

diff --git a/cli/README.md b/cli/README.md
index 3345cc1f99332bc6081040773b24f361fd0b7d44..3ad42c3f51012a6844fb56942cc9ef8b0a884d66 100644 (file)
--- a/cli/README.md
+++ b/cli/README.md
@@ -12,14 +12,16 @@ their KYC-free Blockchain CLI.
 
 You must have [node.js](https://webinstall.dev/node) installed:
 
+### Mac & Linux
+
 ```bash
-# Mac, Linux
 curl https://webinstall.dev/node | bash
 export PATH="${HOME}/.local/opt/node:$PATH"
 ```
 
+### Windows
+
 ```pwsh
-# Windows
 curl.exe -A MS https://webinstall.dev/node | powershell
 PATH %USERPROFILE%\.local\opt\node;%PATH%
 ```
@@ -27,10 +29,14 @@ PATH %USERPROFILE%\.local\opt\node;%PATH%
 ## CrowdNode CLI
 
 ```bash
+# Install to system, globally
 npm install --location=global crowdnode-cli@v1
 ```
 
+Or
+
 ```bash
+# Run without installing
 npx crowdnode-cli@v1
 ```
 
@@ -56,20 +62,20 @@ You will be given these options whenever the existing balance is low.
 
 0. Generate a **permanent** staking key (just one):
    ```bash
-   crowdnode generate ./privkey.wif
+   crowdnode generate
    ```
    (and put a backup in a safe place)
 1. Send a (tiny) Sign Up payment (Đ0.00151072)
    ```bash
-   crowdnode signup ./privkey.wif
+   crowdnode signup
    ```
 2. Accept the Terms of Use via payment (Đ0.00085536)
    ```bash
-   crowdnode accept ./privkey.wif
+   crowdnode accept
    ```
-3. Deposit your stake
+3. Deposit your stake (in DASH)
    ```bash
-   crowdnode deposit ./privkey.wif
+   crowdnode deposit 0.01
    ```
 
 ## All Commmands
@@ -77,16 +83,26 @@ You will be given these options whenever the existing balance is low.
 ```bash
 Usage:
     crowdnode help
-    crowdnode status ./privkey.wif
-    crowdnode signup ./privkey.wif
-    crowdnode accept ./privkey.wif
-    crowdnode deposit ./privkey.wif [amount] [--no-reserve]
-    crowdnode withdrawal ./privkey.wif <permil> # 1-1000 (1.0-100.0%)
+    crowdnode status [keyfile-or-addr]
+    crowdnode signup [keyfile-or-addr]
+    crowdnode accept [keyfile-or-addr]
+    crowdnode deposit [keyfile-or-addr] [dash-amount] [--no-reserve]
+    crowdnode withdrawal [keyfile-or-addr] <percent> # 1.0-100.0 (steps by 0.1)
 
 Helpful Extras:
-    crowdnode generate [./privkey.wif]
-    crowdnode balance ./privkey.wif
-    crowdnode transfer ./source.wif <key-file-or-pub-addr>
+    crowdnode balance [keyfile-or-addr]
+    crowdnode load [keyfile-or-addr] [dash-amount]
+    crowdnode transfer <from-keyfile-or-addr> <to-keyfile-or-addr> [dash-amount]
+
+Key Management & Encryption:
+    crowdnode generate [./privkey.wif] [--plain-text]
+    crowdnode list
+    crowdnode use <addr>            # set as default key
+    crowdnode passphrase            # set or rotate passphrase
+    crowdnode import <keyfile>      # copy and encrypt key
+    crowdnode encrypt               # encrypt all keys
+    crowdnode decrypt               # decrypt all keys
+    crowdnode delete <addr>         # delete key (must have 0 balance)
 
 CrowdNode HTTP RPC:
     crowdnode http FundsOpen <addr>
@@ -104,12 +120,11 @@ CrowdNode HTTP RPC:
 
 ## Glossary
 
-| Term          | Description                                                   |
-| ------------- | ------------------------------------------------------------- |
-| addr          | your Dash address (Base58Check-encoded Pay-to-PubKey Address) |
-| amount        | the integer value of "Duffs" (Đ/100000000)                    |
-| permil        | 1/1000, 1‰, or 0.1% - between 1 and 1000 (0.1% to 100.0%)     |
-| ./privkey.wif | the file path to your staking key in WIF (Base58Check) format |
+| Term          | Description                                                          |
+| ------------- | -------------------------------------------------------------------- |
+| addr          | your Dash address (Base58Check-encoded Pay-to-PubKey Address)        |
+| ./privkey.wif | the file path to your staking key in WIF (Base58Check) format        |
+| signature     | generated with [dashmsg](https://webinstall.dev/dashmsg) or dash-cli |
 
 # JS API Documentation