docs: bring the README up to 1.12.0 - #293
Merged
Merged
Conversation
Notifications gained replying in place and the web-of-trust sort, and the bullet still described only the bell and mute lists. The relay bullet now mentions per-relay icons and the health check. NIP-42 was described as signing AUTH challenges automatically, which undersold the fix and oversold the scope: it is answered for the account's own relays only, and it now covers reads, which is what was actually broken. Two rows were missing from the protocol table: NIP-11, which is where the relay icons and health verdicts come from, and NIP-22, which has carried web comments since 1.7.0 and now also carries replies to them.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README's feature list and protocol table had drifted behind 1.12.0.
Notifications described the bell and mute lists only. It now covers replying in place (NIP-10 for notes, NIP-22 for page comments, and they are not interchangeable) and the web-of-trust sort, including why it groups rather than hides.
Outbox relays now mentions the per-relay icon and the on-demand health check.
NIP-42 was described as "Relay AUTH challenges are signed automatically." That undersold the fix and oversold the scope. It is answered for the account's own relays only, deliberately, because identifying yourself to a relay reached through someone else's hint is a disclosure. And it now covers reads, which is the part that was actually broken: posting always worked, since an event carries its own signature.
Two missing rows in the protocol table: NIP-11, which is where relay icons and health verdicts come from, and NIP-22, which has carried web comments since 1.7.0 and was never listed.
No functional changes.