From 5971fc5dcfada542ddd4a956a02bff3a5c905f6b Mon Sep 17 00:00:00 2001
From: Denis Kirillov <d.kirillov@yadro.com>
Date: Wed, 28 Aug 2024 15:00:52 +0300
Subject: [PATCH] Add README.md

Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>
---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dbbbd41
--- /dev/null
+++ b/README.md
@@ -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.
+```