Added initial information about the project in README.md

This commit is contained in:
BlueFox 2024-03-30 14:42:32 +01:00
parent 4a5accbd4a
commit 96b5fb2865

View File

@ -1,3 +1,14 @@
# NetSpeaker-API-Demo
A collection of demonstrations on how to use the NetSpeaker's API (simple HTML files!)
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.