diff --git a/README.md b/README.md index 3530c6d..4dfe793 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,20 @@ following steps: 2. Fork this repository. -3. Use the [`oasis-registry`] command to generate a new signed statement. The - command must be run in the directory where you cloned this repository. This +3. Use the [`oasis-cli`] command to generate a new signed statement. + For example: + + ```bash + oasis account entity metadata-update \ + --account my-entity-account \ + --registry-dir /path/to/metadata-registry \ + /path/to/entity-metadata.json + ``` + + This will create (or update) the registry entry. + + Or alternatively use the [`oasis-registry`] command to generate the signed statement. + The command must be run in the directory where you cloned this repository. This will require the use of an Oasis Core signer (all the same signers and configuration flags are supported). For example, using a file-based signer: @@ -51,8 +63,6 @@ following steps: /path/to/entity-metadata.json ``` - This will create (or update) the registry entry. - 4. Commit your changes in the `registry/` directory and create a pull request. Make sure to NOT commit the plain `entity-metadata.json` file in case you created it in the same directory. The same metadata can be extracted from the @@ -65,6 +75,7 @@ following steps: happens the updated entity metadata will be available for queries. +[`oasis-cli`]: https://github.com/oasisprotocol/cli [`oasis-registry`]: https://github.com/oasisprotocol/metadata-registry-tools [ADR 0001]: docs/adr/0001-entity-metadata.md