Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: add example using oasis cli to sign #328

Merged
merged 1 commit into from
Dec 4, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,14 @@ 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
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:
3. Use the [`oasis-cli`] (minimum version 0.7.1) command to generate a new signed statement.
For example:

```bash
oasis-registry entity update \
--signer.dir /localhostdir/entity \
/path/to/entity-metadata.json
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.
Expand All @@ -65,7 +64,7 @@ following steps:
happens the updated entity metadata will be available for queries.

<!-- markdownlint-disable line-length -->
[`oasis-registry`]: https://github.com/oasisprotocol/metadata-registry-tools
[`oasis-cli`]: https://docs.oasis.io/general/manage-tokens/cli/
[ADR 0001]: docs/adr/0001-entity-metadata.md
<!-- markdownlint-enable line-length -->

Expand Down