Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/melvincarvalho/nostrefresh
nostrefresh
https://github.com/melvincarvalho/nostrefresh
nostr
Last synced: about 1 month ago
JSON representation
nostrefresh
- Host: GitHub
- URL: https://github.com/melvincarvalho/nostrefresh
- Owner: melvincarvalho
- License: mit
- Created: 2022-02-17T17:17:41.000Z (almost 3 years ago)
- Default Branch: gh-pages
- Last Pushed: 2024-05-28T19:01:39.000Z (7 months ago)
- Last Synced: 2024-05-29T09:29:26.924Z (7 months ago)
- Topics: nostr
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nostr - nostrefresh - simple refresh function for nostr web pages (Tools / Client reviews and/or comparisons)
README
Nostrefresh
Simple refresh function for nostr web pages---
Getting Started
---
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![npm](https://img.shields.io/npm/v/nostrefresh)](https://npmjs.com/package/nostrefresh)
[![npm](https://img.shields.io/npm/dw/nostrefresh.svg)](https://npmjs.com/package/nostrefresh)
[![Github Stars](https://img.shields.io/github/stars/melvincarvalho/nostrefresh.svg)](https://github.com/melvincarvalho/nostrefresh/)## ⚡️ Features
✓ Connect to nostr relay
✓ Refresh page on update
✓ Relay and refresh time configurable from query string## ✍️ Getting Started
---
### Import to web page
```JavaScript
import 'https://cdn.skypack.dev/nostrefresh'
```---
### How it works
The code will check two parameters in the query string
- relay
- tThe relay is a [nostr](https://github.com/fiatjaf/nostr) relay, t is the time in seconds, with default - 5
---
## ⚖️ License
This project is under the MIT License. See the [LICENSE](https://github.com/melvincarvalho/nostrefresh/blob/gh-pages/LICENSE) file for the full license text.