upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/31.md
diff options
context:
space:
mode:
authorpablof7z <p@f7z.io>2023-06-08 22:27:00 +0200
committerpablof7z <p@f7z.io>2023-06-08 22:27:00 +0200
commit964bc5b5ce946ab66aae945084549f26ffdef70f (patch)
tree750c299cd8c28a672f18739b579f7fe1952470ff /31.md
parentb8aec7dad561a8b27e22a91638dd04f2851a0c5c (diff)
update NIP to use alt tag
Diffstat (limited to '31.md')
-rw-r--r--31.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/31.md b/31.md
index 675c249..e77ae34 100644
--- a/31.md
+++ b/31.md
@@ -6,8 +6,10 @@ Dealing with unknown event kinds
6 6
7`draft` `optional` `author:pablof7z` `author:fiatjaf` 7`draft` `optional` `author:pablof7z` `author:fiatjaf`
8 8
9When creating a new custom event kind that is part of a custom protocol and isn't meant to be read as text (like `kind:1`), clients should use the `tags` field to store all their custom data related to their protocol, and use the `content` field to write a short human-readable plaintext summary of what that event is about. 9When creating a new custom event kind that is part of a custom protocol and isn't meant to be read as text (like `kind:1`), clients should use an `alt` tag to write a short human-readable plaintext summary of what that event is about.
10 10
11The intent is that social clients, used to display only `kind:1` notes, can still show something in case a custom event pops up in their timelines. 11The intent is that social clients, used to display only `kind:1` notes, can still show something in case a custom event pops up in their timelines. The content of the `alt` tag should provide enough context for a user that doesn't know anything about this event kind to understand what it is.
12 12
13These clients that only know `kind:1` are not expected to ask relays for events of different kinds, but users could still reference these weird events on their notes, and without proper context these could be nonsensical notes. Having the fallback text makes that situation much better -- even if only for making the user aware that they should try to view that custom event elsewhere. 13These clients that only know `kind:1` are not expected to ask relays for events of different kinds, but users could still reference these weird events on their notes, and without proper context these could be nonsensical notes. Having the fallback text makes that situation much better -- even if only for making the user aware that they should try to view that custom event elsewhere.
14
15`kind:1`-centric clients can make interacting with these event kinds more functional by supporting [NIP-89](https://github.com/nostr-protocol/nips/blob/master/89.md).