Revise NIP 85 reviews

This commit is contained in:
Jon Staab 2024-09-25 09:42:09 -07:00
parent 0b8c76158c
commit 0b5afbb651

39
85.md
View File

@ -4,49 +4,30 @@ NIP-85
Reviews
-------
Kind `1986` MAY be used to leave a review with optional ratings.
This NIP describes several different types of `review` which follow a single set of conventions.
The `content` field SHOULD include a human-readable review.
In all cases, the `content` field SHOULD include a human-readable review. A single [NIP 73](./73.md) `i` tag indicates the object of the review. This allows for reviews of events, people, topics, relays, or external guids.
The review event MUST include one or more `e`, `a`, `p`, `t`, or `r` tags indicating
the object of the review. This allows for reviews of events, people, topics, and relays
or external resources. As with NIP-01, a relay hint SHOULD be included when using `e` and
`p` tags.
# Ratings
Tags MAY contain additional `rating` tags each of which should have a `value` between 0 and 1,
and an optional `mark` specifying an attribute of the thing being reviewed.
Tags MAY contain NIP 32 labels to help categorize what is being reviewed.
# Review Kinds
Examples
--------
## Relays
A relay review with rating metadata.
Kind `1987` indicates a review of a relay:
```json
{
"kind": 1986,
"kind": 1987,
"content": "This relay is fast!",
"tags": [
["L", "review"],
["l", "review/relay", "review"],
["rating", "0.8"],
["rating", "0.2", "smell"],
["rating", "1", "service"],
["r", <relay_url>]
],
}
```
A review of a podcast episode.
```json
{
"kind": 1986,
"content": "This was a great episode.",
"tags": [
["rating", "1"],
["r", <podcast guid in a standard format>]
["rating", "0.2", "content"],
["rating", "1", "speed"],
["i", "wss://relay.example.com/"]
],
}
```