From 35ae3c670757bd0f950d91d694805c228a9b5d8d Mon Sep 17 00:00:00 2001 From: Georgi Gerganov Date: Sat, 9 Jan 2021 16:25:28 +0200 Subject: [PATCH] Update README.md --- examples/waver/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/examples/waver/README.md b/examples/waver/README.md index 0d6bf97..aa8d606 100644 --- a/examples/waver/README.md +++ b/examples/waver/README.md @@ -4,6 +4,8 @@ Waver allows you to send and receive text messages from nearby devices through s This application can be used to communicate with multiple nearby devices at once. Both audible and ultrasound communication protocols are available. The app does not connect to the internet and all information is transmitted only through sound. In order to receive incoming messages you only need to allow access to your device's microphone so that it can record nearby sounds. +The main purpose of this app is to showcase the capabilities of the [ggwave](https://github.com/ggerganov/ggwave/) library. It is a convenient way to quickly test the transmission performance on virtually any device with speakers and a microphone. + ### Install Download on the App Store @@ -45,3 +47,4 @@ As of v1.3.0 Waver supports file sharing. It works like this: ## Known issues - The browser version does not support on-screen keyboard on mobile devices, so it is not possible to input messages. Use the mobile app instead +- In some cases utlrasound transmission is not supported (see [#5](https://github.com/ggerganov/ggwave/issues/5))