diff --git a/README.md b/README.md index b67ca09..4bcf65c 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,15 @@ This module allows to run "websites" on an Arduino that communicate via WebSerial and can be used to control the Arduino, display measurements, etc. +in order to use this module, simply add the following url to your modules in your configuration: +https://edrys-labs.github.io/module-arduinoview/ +The fun part is, that the actual experiment is hosted on your Arduino, it will host the entire website and if you connect different devices, the same lab configuration can host various experiments. + +See the example at + +https://github.com/edrys-labs/lab-arduinoview/ ## Arduino @@ -27,4 +34,4 @@ This folder contains the ArduinoView library and the example sketches. ### Documentation -For more information, see the original [documentation](documentation/Dodumentation.md). \ No newline at end of file +For more information, see the original [documentation](documentation/Dodumentation.md). diff --git a/documentation/doc/Alternatives.md b/documentation/Alternatives.md similarity index 100% rename from documentation/doc/Alternatives.md rename to documentation/Alternatives.md diff --git a/documentation/doc/Documentation.md b/documentation/Documentation.md similarity index 100% rename from documentation/doc/Documentation.md rename to documentation/Documentation.md diff --git a/documentation/doc/Installation.md b/documentation/Installation.md similarity index 100% rename from documentation/doc/Installation.md rename to documentation/Installation.md diff --git a/documentation/doc/Introduction.md b/documentation/Introduction.md similarity index 100% rename from documentation/doc/Introduction.md rename to documentation/Introduction.md diff --git a/documentation/doc/MyImages/ArduinoviewLayers.dia b/documentation/MyImages/ArduinoviewLayers.dia similarity index 100% rename from documentation/doc/MyImages/ArduinoviewLayers.dia rename to documentation/MyImages/ArduinoviewLayers.dia diff --git a/documentation/doc/MyImages/ArduinoviewLayers.png b/documentation/MyImages/ArduinoviewLayers.png similarity index 100% rename from documentation/doc/MyImages/ArduinoviewLayers.png rename to documentation/MyImages/ArduinoviewLayers.png diff --git a/documentation/doc/MyImages/StringFormer.png b/documentation/MyImages/StringFormer.png similarity index 100% rename from documentation/doc/MyImages/StringFormer.png rename to documentation/MyImages/StringFormer.png diff --git a/documentation/doc/MyImages/mainWindow.png b/documentation/MyImages/mainWindow.png similarity index 100% rename from documentation/doc/MyImages/mainWindow.png rename to documentation/MyImages/mainWindow.png