From 4c0f9632925eb0ffe94453e45a7bed77c0ab1e6b Mon Sep 17 00:00:00 2001 From: alltheseas <64376233+alltheseas@users.noreply.github.com> Date: Mon, 4 Nov 2024 20:34:24 -0600 Subject: [PATCH] Update 11.md with banner, and icon fields (#1555) * Update 11.md with banner field Added banner relay metadata field. If nostr relay management is not to be relegated to PhD or protocol developers only, an effort should be made by relay owners to communicate with non-dev non-technical nostr end users. A banner is a visual representation of the relay. It should aim to visually communicate the brand of the relay. * Update 11.md with icon added icon field * Update 11.md updated banner language * Update 11.md updated icon link examples updated icon link examples * Update 11.md grammar * Update 11.md remove .ICO format removed .ICO format * Update 11.md - moved, and merged icon examples Moved up previous Icon section, and removed overlapping/duplication of icon example link content. --- 11.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/11.md b/11.md index 0ca5870..8efd0f0 100644 --- a/11.md +++ b/11.md @@ -14,6 +14,8 @@ When a relay receives an HTTP(s) request with an `Accept` header of `application { "name": , "description": , + "banner": , + "icon": , "pubkey": , "contact": , "supported_nips": , @@ -35,6 +37,21 @@ A relay may select a `name` for use in client software. This is a string, and S Detailed plain-text information about the relay may be contained in the `description` string. It is recommended that this contain no markup, formatting or line breaks for word wrapping, and simply use double newline characters to separate paragraphs. There are no limitations on length. +### Banner + +To make nostr relay management more user friendly, an effort should be made by relay owners to communicate with non-dev non-technical nostr end users. A banner is a visual representation of the relay. It should aim to visually communicate the brand of the relay, complementing the text `Description`. [Here is an example banner](https://image.nostr.build/232ddf6846e8aea5a61abcd70f9222ab521f711aa545b7ab02e430248fa3a249.png) mockup as visualized in Damus iOS relay view of the Damus relay. + +### Icon + +Icon is a compact visual representation of the relay for use in UI with limited real estate such as a nostr user's relay list view. Below is an example URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. + +```jsonc +{ + "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", + // other fields... +} +``` + ### Pubkey An administrative contact may be listed with a `pubkey`, in the same format as Nostr events (32-byte hex for a `secp256k1` public key). If a contact is listed, this provides clients with a recommended address to send encrypted direct messages (See [NIP-17](17.md)) to a system administrator. Expected uses of this address are to report abuse or illegal content, file bug reports, or request other technical assistance. @@ -257,17 +274,6 @@ Relays that require payments may want to expose their fee schedules. } ``` -### Icon - -A URL pointing to an image to be used as an icon for the relay. Recommended to be squared in shape. - -```jsonc -{ - "icon": "https://nostr.build/i/53866b44135a27d624e99c6165cabd76ac8f72797209700acb189fce75021f47.jpg", - // other fields... -} -``` - ### Examples As of 2 May 2023 the following command provided these results: