diff --git a/README.md b/README.md index d8f90c1..7cee11f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,54 @@ -# nostrefresh -nostrefresh +
+

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 +- t + +The 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. diff --git a/package.json b/package.json index 81d21bd..e5d602d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "nostrefresh", - "version": "0.0.1", + "version": "0.0.2", "description": "refresh via nostr relay", "main": "index.js", "type": "module",