updated documentation

it-ony · Jul 31, 2017 · f6e8e45 · f6e8e45
1 parent 33aca13
commit f6e8e45
Showing 1 changed file with 21 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,22 @@
 # cssrefresh
-refresh css files
+
+CSSrefresh is a small javascript library that monitors the CSS-files included in your 
+webpage. Within 1 second after changing an included css file the style changes are 
+applied to the webpage without reloading the browser.
+
+This project is inspired by 
+[http://cssrefresh.frebsite.nl/](http://cssrefresh.frebsite.nl/), but rewritten from
+scratch as I couldn't find any github repository or twitter profile to communicate the 
+issue that made it not working for me anymore.
+
+Usage
+--
+
+```html
+<body>
+    <script async src="https://it-ony.github.io/cssrefresh/cssrefresh.js"></script>
+</body>
+```
+
+or visit [https://it-ony.github.io/cssrefresh](https://it-ony.github.io/cssrefresh) and
+drag the bookmarklet to your bookmark bar.