X-Git-Url: https://git.josue.xyz/?a=blobdiff_plain;f=cli%2FREADME.md;h=2378d7280616a3a58993c03bf85668e884f5548b;hb=de2d6dcd0d93b014e64bd856ab281a7cd243c868;hp=3345cc1f99332bc6081040773b24f361fd0b7d44;hpb=ce14ba4beb779a4a026bbe0e1c869583ca5e572a;p=crowdnode.js%2F.git diff --git a/cli/README.md b/cli/README.md index 3345cc1..2378d72 100644 --- 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 ``` @@ -67,9 +73,9 @@ You will be given these options whenever the existing balance is low. ```bash crowdnode accept ./privkey.wif ``` -3. Deposit your stake +3. Deposit your stake (in Dash) ```bash - crowdnode deposit ./privkey.wif + crowdnode deposit ./privkey.wif 10.0 ``` ## All Commmands @@ -80,13 +86,14 @@ Usage: crowdnode status ./privkey.wif crowdnode signup ./privkey.wif crowdnode accept ./privkey.wif - crowdnode deposit ./privkey.wif [amount] [--no-reserve] - crowdnode withdrawal ./privkey.wif # 1-1000 (1.0-100.0%) + crowdnode deposit ./privkey.wif [dash-amount] [--no-reserve] + crowdnode withdrawal ./privkey.wif # 1.0-100.0 (steps by 0.1) Helpful Extras: crowdnode generate [./privkey.wif] + crowdnode load [./privkey.wif] [dash-amount] crowdnode balance ./privkey.wif - crowdnode transfer ./source.wif + crowdnode transfer ./source.wif [dash-amount] CrowdNode HTTP RPC: crowdnode http FundsOpen @@ -104,12 +111,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