aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJan Tuomi <jan.tuomi@eficode.com>2018-03-03 17:31:41 +0200
committerJan Tuomi <jan.tuomi@eficode.com>2018-03-03 17:31:41 +0200
commit36db691678b1062831358e285aa6407f05647a78 (patch)
tree42821367fb19f959f40cd209732afea17031d07f /README.md
parentf050e5fdbfefe13f59bfca6bfdbc787ac06a53d2 (diff)
Add description
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.md b/README.md
index ab2ea55..297d0b0 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,15 @@
# Vigilante
+## Description
+
+Store all your observables in one place. `Vigilante` consists only of one function, `vigilante.observe(keyword)`, that is used to get an observable from the store.
+
+## Get it
+
+```shell
+yarn install vigilante
+```
+
## Example
app.tag
@@ -43,10 +53,4 @@ push-button.tag
}
</script>
</push-button>
-```
-
-## Get it
-
-```shell
-yarn install vigilante
``` \ No newline at end of file