From a10f7e608005d5a1fcf5315ff505af25d2d101e7 Mon Sep 17 00:00:00 2001 From: Guy Van Sanden Date: Mon, 1 Sep 2025 10:06:32 +0200 Subject: [PATCH] Documentation --- .gitignore | 1 + Changelog.md | 6 ++++++ README.md | 7 ++++++- 3 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 Changelog.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5093a29 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +scripts/ diff --git a/Changelog.md b/Changelog.md new file mode 100644 index 0000000..b3f9e75 --- /dev/null +++ b/Changelog.md @@ -0,0 +1,6 @@ +## [1.0.0] - 2025-09-01 +### Added +- Initial version with control channel. + +### Fixed + diff --git a/README.md b/README.md index 7cf324c..9b447e2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ # simplex-customerservicebot -A bot to handle customer service using SimpleX chat \ No newline at end of file +A bot to handle customer service using SimpleX chat. +The bot will join a group specified in the environment variable SXC_CONTROL_GROUP and announce newly created chats. + +Members of the control group can then be invited into the customer chat group by typing 'join ' + +This requires a working simplex-chat in the background and joining the operator users as well as the bot into the control group. \ No newline at end of file