Updated README

daanpeer · May 19, 2017 · 63c20e1 · 63c20e1
1 parent ddf567f
commit 63c20e1
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+## Spinner
+It's a spinner.
+
+## How to use
+First import the spinner:
+
+`import spinner from 'most-awesome-spinner'`
+
+The spinner accepts two parameters.
+
+`spinner(() => string, timeout: number)`