Add README.md

Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>
This commit is contained in:
Denis Kirillov 2024-08-28 15:00:52 +03:00
parent 38a5a5aed4
commit 5971fc5dcf

42
README.md Normal file
View file

@ -0,0 +1,42 @@
# Policy contract reader
To build:
```
$ make
```
to list all container targets:
```
$ ./bin/policy-reader contract -r http://morph-chain.frostfs.devenv:30333 list-targets --type container
container targets: 3
7h7NcXcF6k6b1yidqEHc1jkyXUm1MfUDrrTuHAefhiDe (base64: 'N2g3TmNYY0Y2azZiMXlpZHFFSGMxamt5WFVtMU1mVURyclR1SEFlZmhpRGU=')
Ei2Fz988ZUFEHUEXxTadouysebPGAW7vsxn1hSiYYzT (base64: 'RWkyRno5ODhaVUZFSFVFWHhUYWRvdXlzZWJQR0FXN3ZzeG4xaFNpWVl6VA==')
Ew23XpQadxG5iyujTg2xPajaQXnN17tWSjgFk7Bv5ADj (base64: 'RXcyM1hwUWFkeEc1aXl1alRnMnhQYWphUVhuTjE3dFdTamdGazdCdjVBRGo=')
```
see additional params:
```
./bin/policy-reader -h
Helps reading policy information from contact in FrostFS network
Usage:
policy-reader [flags]
policy-reader [command]
Examples:
policy-reader --version
Available Commands:
completion Generate the autocompletion script for the specified shell
contract Operations with policy contract
help Help about any command
Flags:
-c, --config string Path to config file
-h, --help help for policy-reader
-v, --version version for policy-reader
Use "policy-reader [command] --help" for more information about a command.
```