Initial commit

1 files changed, 52 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ab2ea55
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# Vigilante
+
+## Example
+
+app.tag
+```jsx
+<app>
+  <counter />
+  <push-button />
+
+  <script>
+    import { observe } from 'vigilante';
+  </script>
+</app>
+```
+
+counter.tag
+```jsx
+<counter>
+  <h3>Times clicked: { count }</h3>
+  <push-button />
+
+  <script>
+    this.count = 0;
+    const counter = this;
+    
+    observe('clicker').on('click', () => {
+      counter.count += 1;
+      counter.update();
+    });
+  </script>
+</counter>
+```
+
+push-button.tag
+```jsx
+<push-button>
+  <button onclick={ click }>Click me!</button>
+
+  <script>
+    click() {
+      observe('clicker').trigger('click');
+    }
+  </script>
+</push-button>
+```
+
+## Get it
+
+```shell
+yarn install vigilante
+```
\ No newline at end of file