README: Clarify registry directory location

oasisprotocol · Dec 7, 2023 · f2e31f9 · f2e31f9
1 parent 3836af9
commit f2e31f9
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -40,7 +40,8 @@ following steps:
 
 2. Fork this repository.
 
-3. Use the [`oasis-cli`] (minimum version 0.7.1) command to generate a new signed statement.
+3. Use the [`oasis-cli`] (minimum version 0.7.1) command to generate a new
+   signed statement.
    For example:
 
    ```bash
@@ -50,6 +51,10 @@ following steps:
       /path/to/entity-metadata.json
    ```
 
+   _Note that for `--registry-dir` you must specify the path to the top-level
+   `metadata-registry` directory (e.g. the one containing this README file) and
+   not any of its subdirectories._
+
    This will create (or update) the registry entry.
 
 4. Commit your changes in the `registry/` directory and create a pull request.