From 5c8b0f1f46e02fd450613a0cfb99f1ff006988dd Mon Sep 17 00:00:00 2001 From: Marco Bakera Date: Tue, 3 Aug 2021 10:52:53 +0200 Subject: [PATCH] spaceapi: add documentation --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 7ad3e62..9c9c39d 100644 --- a/README.md +++ b/README.md @@ -274,6 +274,15 @@ Then just: mxma requires all commands to be run as bot owner. +#### SpaceAPI + +Polls the status of Hack- and Makerspaces that provide an endpoint +that conforms to the [SpaceAPI](https://spaceapi.io/) protocol and notifies +about changes of the opening status. + +To add a new endpoint simply use +`!spaceapi add https://hackspace.example.org/status` + ### Url Watches all messages in a room and if a url is found tries to fetch it and