From c26057019fcacb8bd4f2ab27bd98d0be3f80984f Mon Sep 17 00:00:00 2001
From: thijsoid <thijsoid@xpub.nl>
Date: Mon, 12 Feb 2024 09:35:11 +0100
Subject: [PATCH] Add headers and code snippets to readme

---
 readme.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/readme.md b/readme.md
index 6578507..cfdd502 100644
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,25 @@
 # Twitch Plays Plotter
 
+A javascript based project with which you can control a pen plotter through the chat of a Twitch livestream.
+
+## Setup
+The channel you connect to is specified with the following lines. No authentication is needed, if you're only reading from the chat.
+```javascript
+const client = new tmi.Client({
+    channels: ['twitchplaysplotter']
+});
+```
+
+The communicative channel with the plotter might depend on your specific plotter and the port it is connected to. This is specified with the following lines:
+```javascript
+const port = new SerialPort({
+    path: '/dev/ttyUSB0',
+    baudRate: 9600,
+})
+```
+
+
+## Supported commands
 The tale of the untested bit of javascript:
 
 the commands are right now