From 176f77c0ac790e2fbe949839dd9084dbda7e4f79 Mon Sep 17 00:00:00 2001 From: Jan-Piet Mens Date: Sat, 13 Apr 2019 19:44:23 +0200 Subject: [PATCH] add note about lowercasing user/device names closes #300 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 272c26c..e3681f8 100644 --- a/README.md +++ b/README.md @@ -229,6 +229,8 @@ Unless already provided by the package you installed, we recommend you create a You also need to provide API keys for the maps. +Note: all usernames and device names stored by the Recorder [are lowercased](doc/DESIGN.md) which means filenames etc. are also in lowercase. As an example, if your device publishes topics for user `Fred` (which is perfectly valid), the Recorder will turn that into `fred`, likewise for `Phone` which becomes `phone` as device name. + ### `ot-recorder` options This section lists the most important options of the Recorder with their long names; check the usage (`recorder -h`) for the short versions.