From cc30d49e2a9bb2168e3d887d0aea50825d88e2c6 Mon Sep 17 00:00:00 2001 From: Dmitry Repchevsky Date: Wed, 18 Oct 2023 14:03:28 +0200 Subject: [PATCH] Create README.md --- beacon-v2-validator-tool/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 beacon-v2-validator-tool/README.md diff --git a/beacon-v2-validator-tool/README.md b/beacon-v2-validator-tool/README.md new file mode 100644 index 0000000..6d381d8 --- /dev/null +++ b/beacon-v2-validator-tool/README.md @@ -0,0 +1,19 @@ +### Simple Beacon v2 validator + +Building the **neat-beacon-v2-validator** leaves vaildator commandline tool in the **target** directory: +neat-beacon-v2-validator/beacon-v2-validator-tool/target/neat-beacon-v2-validator.jar + +The tool needs the Beacon's API endpoint for validation and optionally output report file. + +Usage: +``` +beacon-validator -f url [-o file] + +parameters: + -h (--help) - help message + -f (--framework) - location of the beacon + -o (--output) - report output file +examples: +>java -jar neat-beacon-v2-validator.jar -f https://beacon-apis-demo.ega-archive.org/api +>java -jar neat-beacon-v2-validator.jar -f https://beacon-apis-demo.ega-archive.org/api -o report.json +```