From 19709d9db73a71f291fbf5a417da328c16ea6e92 Mon Sep 17 00:00:00 2001
From: waldek <waldek@helloworld>
Date: Tue, 2 Jul 2019 21:12:51 +0200
Subject: [PATCH] updated readme file with osc server info

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e9c1e6e..5d5f634 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# puredata
+# puredata class
 
 This repo contains a short puredata class with some examples and a webserver.
 Use pandoc to generate the index.html in the source directory.
@@ -9,6 +9,28 @@ Dependencies:
 * pandoc
 * python3 bottle framework
 
+It also includes a small OSC server that can be used to dispatch data to clients.
+This server fetches JSON data from online sources and formats it to OSC bundles.
+It currently dispatches:
+
+* weather data
+* bitcoin price data
+* cpu and ram data
+
+To run the server you need these python3 dependencies that can be installed with pip.
+
+* python-osc
+* psutil
+
+The server **listens** on port **8080** and send OSC data back on port **8081** to the client who requested the data.
+The following OSC messages can be sent to the server.
+
+```python
+/get/weather [CITY]
+/get/bitcoin
+/get/cpu
+```
+
 # todo
 
 * have each chapter be more verbose