upleb.uk

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

summaryrefslogtreecommitdiff
path: root/24.md
diff options
context:
space:
mode:
Diffstat (limited to '24.md')
-rw-r--r--24.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/24.md b/24.md
new file mode 100644
index 0000000..3adec24
--- /dev/null
+++ b/24.md
@@ -0,0 +1,43 @@
1NIP-24
2======
3
4Extra metadata fields and tags
5------------------------------
6
7`draft` `optional`
8
9This NIP defines extra optional fields added to events.
10
11kind 0
12======
13
14These are extra fields not specified in NIP-01 that may be present in the stringified JSON of metadata events:
15
16 - `display_name`: an alternative, bigger name with richer characters than `name`. `name` should always be set regardless of the presence of `display_name` in the metadata.
17 - `website`: a web URL related in any way to the event author.
18 - `banner`: an URL to a wide (~1024x768) picture to be optionally displayed in the background of a profile screen.
19 - `bot`: a boolean to clarify that the content is entirely or partially the result of automation, such as with chatbots or newsfeeds.
20
21### Deprecated fields
22
23These are fields that should be ignored or removed when found in the wild:
24
25 - `displayName`: use `display_name` instead.
26 - `username`: use `name` instead.
27
28kind 3
29======
30
31These are extra fields not specified in NIP-02 that may be present in the stringified JSON of follow events:
32
33### Deprecated fields
34
35 - `{<relay-url>: {"read": <true|false>, "write": <true|false>}, ...}`: an object of relays used by a user to read/write. [NIP-65](65.md) should be used instead.
36
37tags
38====
39
40These tags may be present in multiple event kinds. Whenever a different meaning is not specified by some more specific NIP, they have the following meanings:
41
42 - `r`: a web URL the event is referring to in some way
43 - `title`: name of [NIP-51](51.md) sets, [NIP-52](52.md) calendar event, [NIP-53](53.md) live event or [NIP-99](99.md) listing