From bada3d12438fecf4b2fb29fd3372d5ad12f26214 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Miroslav=20=C5=A0ediv=C3=BD?= <sedivy.miro@gmail.com>
Date: Sun, 31 Jul 2022 23:38:19 +0200
Subject: [PATCH] add README.

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..b9acd68e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+# neko-client
+Connect to [demodesk/neko](https://github.com/demodesk/neko) backend with self contained vue component. 
+
+For **community edition** neko with GUI and _plug & play_ deployment visit [m1k1o/neko](https://github.com/m1k1o/neko).
+
+## Installation
+Code is published to public GitHub npm repository.
+
+```bash
+# npm command
+npm i @demodesk/neko
+# yarn command
+yarn add @demodesk/neko
+```
+
+### Registry setup
+
+```bash
+# npm command
+echo @demodesk:registry=https://npm.pkg.github.com >> .npmrc
+# yarn command
+echo \"@demodesk:registry\" \"https://npm.pkg.github.com\" >> .yarnrc
+```
+
+### Example
+API consists of accessing Vue reactive state, calling various methods and subscribing to events. Simple usage:
+
+```html
+<!-- import vue -->
+<script src="https://unpkg.com/vue"></script>
+
+<!-- import neko -->
+<script src="./neko.umd.js"></script>
+<link rel="stylesheet" href="./neko.css">
+
+<div id="app">
+  <neko ref="neko" server="http://127.0.0.1:3000/api" autologin autoplay />
+</div>
+
+<script>
+new Vue({
+  components: { neko },
+  mounted() {
+    // access state
+    // this.$refs.neko.state.session_id
+  
+    // call methods
+    // this.$refs.neko.setUrl('http://127.0.0.1:3000/api')
+    // this.$refs.neko.login('username', 'password')
+    // this.$refs.neko.logout()
+  
+    // subscribe to events
+    // this.$refs.neko.events.on('room.control.host', (id) => { })
+  },
+}).$mount('#app')
+</script>
+```