mirror of
https://github.com/clitor-is-protocol/kevacoin-cli.git
synced 2025-01-31 00:44:18 +00:00
update readme
This commit is contained in:
parent
dfb83f1250
commit
98ec818eb6
22
README.md
22
README.md
@ -2,18 +2,14 @@
|
|||||||
|
|
||||||
CLI tools for KevaCoin
|
CLI tools for KevaCoin
|
||||||
|
|
||||||
|
### docs
|
||||||
|
|
||||||
|
* [protocol specification](https://clitor-is-protocol.github.io)
|
||||||
|
|
||||||
### put
|
### put
|
||||||
|
|
||||||
export FS object to blockchain
|
export FS object to blockchain
|
||||||
|
|
||||||
#### logic
|
|
||||||
|
|
||||||
* create separated namespace with file basename as `_KEVA_NS_`
|
|
||||||
* append protocol version as `_CLITOR_IS_`
|
|
||||||
* encode file content to base64 string
|
|
||||||
* split encoded string to `3072` byte pieces
|
|
||||||
* save pieces as indexed record values
|
|
||||||
|
|
||||||
#### example
|
#### example
|
||||||
|
|
||||||
```
|
```
|
||||||
@ -30,10 +26,6 @@ php src/put.php processor filename [delay]
|
|||||||
|
|
||||||
check (validate) existing namespace and fix missed FS pieces in blockchain
|
check (validate) existing namespace and fix missed FS pieces in blockchain
|
||||||
|
|
||||||
#### logic
|
|
||||||
|
|
||||||
similar to the [put](#put) logic but using namespace provided as the additional argument
|
|
||||||
|
|
||||||
#### example
|
#### example
|
||||||
|
|
||||||
```
|
```
|
||||||
@ -51,12 +43,6 @@ php src/fix.php processor namespace filename [delay]
|
|||||||
|
|
||||||
import stored object from blockchain to FS location
|
import stored object from blockchain to FS location
|
||||||
|
|
||||||
#### logic
|
|
||||||
|
|
||||||
* check namespace for `_CLITOR_IS_` record
|
|
||||||
* merge indexed records to base64 string
|
|
||||||
* decode merged string to original file and save to FS
|
|
||||||
|
|
||||||
#### example
|
#### example
|
||||||
|
|
||||||
```
|
```
|
||||||
|
Loading…
x
Reference in New Issue
Block a user