diff --git a/README.md b/README.md deleted file mode 100644 index 25e78ee..0000000 --- a/README.md +++ /dev/null @@ -1,24 +0,0 @@ -### This is a template for writing a bot using simplematrixbotlib - -#### Setup - -First clone repo and create `.env` and `config.toml` - -Examples: - -`.env` -```dotenv -USERNAME=@catbot:example.com -PASSWORD=password -SERVER=https://example.com -``` - -[allowlist and blocklist formats](https://simple-matrix-bot-lib.readthedocs.io/en/latest/examples.html#id2) - -`config.toml` -```toml -[simplematrixbotlib.config] -allowlist = [] -blocklist = [] -admin_id = '@admin:example.com' -``` \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..daa7d0d --- /dev/null +++ b/README.rst @@ -0,0 +1,19 @@ +dots-matrix-bot +=============== + +dots-matrix-bot is the interface for +`dots-bot-api `__ to have +access to `Dots Platform Clients API `__ using +matrix. + +Template +======== + +dots-matrix-bot uses +`simplematrixbotlib\ template `__. + +Author +====== + +Kostiantyn Klochko (c) 2023 +