From fc01768ee55ac5485c86a0ee5cb5c7d603358916 Mon Sep 17 00:00:00 2001
From: Daniel Kantor <git@daniel-kantor.com>
Date: Mon, 28 Mar 2022 09:41:11 +0200
Subject: [PATCH] docs: improve documentation (#14)

---
 README.md    | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 package.json |  3 ++-
 2 files changed, 61 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 805d530..cde24b1 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,65 @@
 🌱 🎥 Markdown presentations using your webcam
 
 
+## Usage
+
+
+### Setup
+
+In order to use Zoetic, you need to clone the Zoetic repository:
+
+```bash
+git clone git@github.com:kantord/zoetic.git
+```
+
+`cd` into the newly created folder
+
+```bash
+cd zoetic
+```
+
+Make sure to install dependencies before you try to run your slides:
+
+```bash
+yarn install
+```
+
+### Edit your slides
+
+Place your slides inside `decks/`. See `decks/hello.mdx` for an example. You can use Markdown
+in order to format your slides. In order to create multiple slides in one deck, you can use
+`---` in order to separate the slides, for example:
+
+```mdx
+# First slide
+
+---
+
+Second slide
+```
+
+Want to use React components in your slides, or other more advanced features? Consult the
+[mdx-deck documentation](https://github.com/jxnblk/mdx-deck).
+
+
+### Test and present your slides
+
+In order to run your slides, use `yarn zoetic`. For example, if your slides are in 
+`decks/hello.mdx`, then run
+
+```bash
+yarn zoetic hello.mdx
+```
+
+If you want to use `zoetic` in order to present on an online meeting, you have to use screen
+sharing. Open `zoetic` before joining your call and make sure your camera is turned on and
+zoetic has access to it. Then join your call without enabling your camera in the call.
+
+Once you join your call, share just the zoetic window in the call. If you want to participate
+in the call without the slides before starting your presentation, you can simple include an
+empty slide.
+
+
 
 ## Planned features
 
diff --git a/package.json b/package.json
index 0dddbe4..23f563b 100644
--- a/package.json
+++ b/package.json
@@ -6,7 +6,7 @@
     "access": "public"
   },
   "bin": {
-    "zoetic": "./cli.js"
+    "zoetic": "./generate.js"
   },
   "repository": "git@github.com:kantord/zoetic.git",
   "author": "Dániel Kántor <git@daniel-kantor.com>",
@@ -28,6 +28,7 @@
   "scripts": {
     "start": "./cli.js hello.mdx",
     "build": "./cli.js build hello.mdx",
+    "zoetic": "./cli.js",
     "help": "./cli.js",
     "lint": "eslint .",
     "format": "eslint . --fix"