From 96b5fb2865211827618e9af4ff4a8bb6aa2ba25d Mon Sep 17 00:00:00 2001 From: BlueFox Date: Sat, 30 Mar 2024 14:42:32 +0100 Subject: [PATCH] Added initial information about the project in README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b8fae32..693a551 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # NetSpeaker-API-Demo -A collection of demonstrations on how to use the NetSpeaker's API (simple HTML files!) \ No newline at end of file +A collection of demonstrations on how to use the NetSpeaker's API (simple HTML files!) + +The Netspeaker provides an API which is kind of described [here](https://git.privacynerd.de/NetSpeaker/NetSpeaker#roadmap). This repository contains example web pages which access this API with javascript to display information +and change settings of the Netspeaker. + + +## simpledemo.html + +A demo hosting of simpledemo.html can be found [here](http://netspeaker.privacynerd.de). Please note that +the connection is insecure (HTTP only) as many modern browser's policies won't allow "mixed content" +javascript requests. As the Netspeaker API is not SSL encrypted, theres no way to fix this issue other than +by just serving the page the Javascript runs on only over HTTP.