diff --git a/README.md b/README.md new file mode 100644 index 0000000..9899013 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +You can discuss this bot in [#pingposh:imninja.net](origin_server_ts) + +This is a simple Matrix bot to participate in [#ping:maunium.net](https://matrix.to/#/#ping:maunium.net) + +### Features + +It automatically joins on invites. If someone sends a `!ping` or `!ping `, it echoes back an `m.notice` with the following attributes: + +```json +"pong": { + "ms": , + "from": "", + "ping": "" +} +``` + +### Configuration + +It is configured via command line parameters or environment variables. Have a look at the param block at the beginning of `bot.ps1` for all configuration options. + +Example configuration with environment variables: +```bash +HOMESERVER: 'http://synapse:8008' +USERID: '@pingposh:imninja.net' +ACCESSTOKEN_FILE: '/run/secrets/pingposh_accesstoken' +UNENCRYPTED: 'TRUE' +``` \ No newline at end of file