clitor-is-protocol/kevacoin-cli
1
0
Fork 0
mirror of https://github.com/clitor-is-protocol/kevacoin-cli.git synced 2025-09-05 16:41:46 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
ghost 2024-06-04 13:04:50 +03:00
parent 98ec818eb6
commit 9b5bb48912
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -2,54 +2,56 @@
CLI tools for KevaCoin CLI tools for KevaCoin
### docs ### about
* [protocol specification](https://clitor-is-protocol.github.io) * [protocol specification](https://clitor-is-protocol.github.io)
### put ### documentation
#### put
export FS object to blockchain export FS object to blockchain
#### example ##### example
``` ```
php src/put.php processor filename [delay] php src/put.php processor filename [delay]
``` ```
#### arguments ##### arguments
1. `processor` - path to `kevacoin-cli` 1. `processor` - path to `kevacoin-cli`
2. `filename` - path to source file 2. `filename` - path to source file
3. `delay` - _optional_ delay in seconds for pieces pool to prevent `too-long-mempool-chain` reject, default `60` 3. `delay` - _optional_ delay in seconds for pieces pool to prevent `too-long-mempool-chain` reject, default `60`
### fix #### fix
check (validate) existing namespace and fix missed FS pieces in blockchain check (validate) existing namespace and fix missed FS pieces in blockchain
#### example ##### example
``` ```
php src/fix.php processor namespace filename [delay] php src/fix.php processor namespace filename [delay]
``` ```
#### arguments ##### arguments
1. `processor` - path to `kevacoin-cli` 1. `processor` - path to `kevacoin-cli`
2. `namespace` - hash of namespace where object was stored 2. `namespace` - hash of namespace where object was stored
3. `filename` - path to source file 3. `filename` - path to source file
4. `delay` - _optional_ delay in seconds for pieces pool to prevent `too-long-mempool-chain` reject, default `60` 4. `delay` - _optional_ delay in seconds for pieces pool to prevent `too-long-mempool-chain` reject, default `60`
### get #### get
import stored object from blockchain to FS location import stored object from blockchain to FS location
#### example ##### example
``` ```
php src/get.php processor namespace [filename] php src/get.php processor namespace [filename]
``` ```
#### arguments ##### arguments
1. `processor` - path to `kevacoin-cli` 1. `processor` - path to `kevacoin-cli`
2. `namespace` - hash of namespace where object was stored 2. `namespace` - hash of namespace where object was stored