Skip to content

Commit 169c5ab

Browse files
njhaleoskapt
andcommitted
docs: improve metadata description verbiage
The text as written is ambiguous about if the directives _only_ tag things with Crypto or with the icon, and it's not until the reader scrolls down that they might figure out the reference is to the example below. Adding this small bit of text directs them to the example early on and adds clarity. Signed-off-by: Nick Hale <[email protected]> Co-authored-by: Adrian Goins <[email protected]>
1 parent fc2dd54 commit 169c5ab

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,10 @@ Param: algo: The algorithm to generate a hash with. Default is "sha256". Support
8686

8787
## Tool Metadata
8888

89-
The `tool.gpt` file also provides the following metadata for use in Obot:
89+
The snippet below (from the `tool.gpt` file) also provides the following metadata for use in Obot:
9090

91-
- `!metadata:*:category` which tags tools with the `Crypto` category to promote organization and discovery
92-
- `!metadata:*:icon` which assigns `https://cdn.jsdelivr.net/npm/@phosphor-icons/core@2/assets/duotone/fingerprint-duotone.svg` as the tool icon
91+
- `!metadata:*:category` which tags all tools in the `tool.gpt` file with the `Crypto` category to promote organization and discovery
92+
- `!metadata:*:icon` which assigns `https://cdn.jsdelivr.net/npm/@phosphor-icons/core@2/assets/duotone/fingerprint-duotone.svg` as the tool icon to all tools in the `tool.gpt` file
9393

9494
<br/>
9595

0 commit comments

Comments
 (0)