Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dskvr authored Apr 25, 2024
1 parent 8258e35 commit 60d2171
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ SvelteKit CSR site with SSR disabled that implements `ndk`, `nostr-zap` and `@no

**Why SvelteKit if no SSR?**: No justification other than habit. Convert it in a PR and I won't complain.

## Try it without build/deploy
You can preview your relay on myrelay.page and even edit it without building or deploying it through the netlify build (which is always latest). **Important: Works for `wss` relays only!** Also see [requirements for editing](https://github.com/sandwichfarm/myrelay.page/edit/main/README.md#important-notes)

`https://relaypage.netlify.app/?url=$YOUR_RELAY_URL`

for example
- [snort](https://relaypage.netlify.app/?url=wss://relay.snort.social)
- [damus](https://relaypage.netlify.app/?url=wss://relay.damus.io)
- [damus](https://relaypage.netlify.app/?url=wss://purplepag.es)
- [nostr.land](https://relaypage.netlify.app/?url=wss://nostr.land)

## todo
- general
- [x] `tailwind`
Expand Down Expand Up @@ -115,17 +126,6 @@ _Image is not available on a registry yet_
- if you run a `ws` (unsecured) relay, for instance from onion or a local relay, you must serve _myrelay.page_ from `http`
- You are not serving _myrelay.page_ from the `https` url equivalent of your relay, see below if testing locally.

## Demo your own relay now
URL parameters are disabled by default for various reasons (in the future it can be enabled build-time for novel cases). However, you can preview your relay on myrelay.page and even edit it without building or deploying it through the netlify build (which is always latest). **Important: Works for `wss` relays only!**

`https://relaypage.netlify.app/?url=$YOUR_RELAY_URL`

for example
- [snort](https://relaypage.netlify.app/?url=wss://relay.snort.social)
- [damus](https://relaypage.netlify.app/?url=wss://relay.damus.io)
- [damus](https://relaypage.netlify.app/?url=wss://purplepag.es)
- [nostr.land](https://relaypage.netlify.app/?url=wss://nostr.land)

## dev

```
Expand Down

0 comments on commit 60d2171

Please sign in to comment.