diff --git a/README.md b/README.md index 0dff0a8..f071af4 100644 --- a/README.md +++ b/README.md @@ -2,54 +2,56 @@ CLI tools for KevaCoin -### docs +### about * [protocol specification](https://clitor-is-protocol.github.io) -### put +### documentation + +#### put export FS object to blockchain -#### example +##### example ``` php src/put.php processor filename [delay] ``` -#### arguments +##### arguments 1. `processor` - path to `kevacoin-cli` 2. `filename` - path to source file 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 -#### example +##### example ``` php src/fix.php processor namespace filename [delay] ``` -#### arguments +##### arguments 1. `processor` - path to `kevacoin-cli` 2. `namespace` - hash of namespace where object was stored 3. `filename` - path to source file 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 -#### example +##### example ``` php src/get.php processor namespace [filename] ``` -#### arguments +##### arguments 1. `processor` - path to `kevacoin-cli` 2. `namespace` - hash of namespace where object was stored