diff --git a/README.md b/README.md index d72ca11..c94d4a1 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ that allows near real-time communication in conflicts to exchange early warning and status information to create shared situational awareness. Note that this utility only processes *cultural* heritage sites, because -Whiteflag (currently) only defines a message that corresponds with the +Whiteflag (currently) only defines a message (`P52`) that corresponds with the protective sign for cultural property i.a.w. [the 1954 Hague Convention](http://www.unesco.org/new/en/culture/themes/armed-conflict-and-heritage/convention-and-protocols/1954-hague-convention/). This utility is for technology development, test and evaluation purposes only. @@ -48,7 +48,7 @@ npm link To invoke the Whitefag WHL utility from the command line, use the `wfwhl` command with the following arguments from any directory: -```shell +``` wfwhl [-s ...] [-w |-f ] [-t -i -b -a
] [-ov] ``` @@ -57,15 +57,17 @@ wfwhl [-s ...] [-w |-f ] The main options are the following: -* `-s`, `--sites` : Specify the world heritage site(s) to be processed by \ number; multiple sites may be specified. If no sites are specified, all sites are processed. -* `-w`, `--web` : The source \ of the WHL in XML on the web. If not specified the default is `https://whc.unesco.org/en/list/xml/`. Cannot be used with `-f`. -* `-f`, `--file` : The source \ containing the WHL in XML. Cannot be used with `-w`. -* `-t`, `--transmit` : Transmit the Whiteflag message(s) on the blockchain. Requires `-i`, `-b` and `-a` to be specified. -* `-i`, `--interface` : The Whiteflag API REST interface \ to post the message(s) to be sent. -* `-b`, `--blockchain` : The \ to be used for sending the message(s). -* `-a`, `--address` : The blockchain \ to be used for sending the message(s). -* `-o`, `--stdout` : Send the Whiteflag message(s) to stdout. This allows the data to be piped to other processes. -* `-v`, `--verbose` : Provide detailed processing output. +* `-s`, `--sites` : Specify the world heritage site(s) to be processed by \ number; multiple sites may be specified. If no sites are specified, all sites are processed. +* `-w`, `--web` : The source \ of the WHL in XML on the web. If not specified the default is `https://whc.unesco.org/en/list/xml/`. Cannot be used with `-f`. +* `-f`, `--file` : The source \ containing the WHL in XML. Cannot be used with `-w`. +* `-t`, `--transmit`** : Transmit the Whiteflag message(s) on the blockchain. Requires `-i`, `-b` and `-a` to be specified. +* `-i`, `--interface`** : The Whiteflag API REST interface \ to post the message(s) to be sent. +* `-b`, `--blockchain`** : The \ to be used for sending the message(s). +* `-a`, `--address`** : The blockchain \ to be used for sending the message(s). +* `-o`, `--stdout` : Send the Whiteflag message(s) to stdout. This allows the data to be piped to other processes. +* `-v`, `--verbose` : Provide detailed processing output. + +**: _in development_ Other supporting options are: