improve README

README.md

@@ -1,2 +1,54 @@
-# nostrefresh
-nostrefresh
+<div align="center">
+  <h1>Nostrefresh</h1>
+</div>
+
+<div align="center">  
+Simple refresh function for nostr web pages
+</div>
+
+---
+
+<div align="center">
+<h4>Getting Started</h4>
+</div>
+  
+---
+  
+
+[![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
+
+&nbsp;&nbsp;✓&nbsp; Connect to nostr relay  
+&nbsp;&nbsp;✓&nbsp; Refresh page on update  
+&nbsp;&nbsp;✓&nbsp; 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.

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",