diff --git a/README.md b/README.md index dbdbf19..9d8eb14 100644 --- a/README.md +++ b/README.md @@ -23,17 +23,17 @@ pip install -r requirements.txt First, copy config.json.example to config.json. Then fill in the fields: -`tokens.hs`: A randomly generated token -`tokens.as`: Another randomly generated token -`tokens.telegram`: The Telegram bot API token, as generated by @BotFather -`tokens.google`: A Google API key, used for URL shortening. Can be left out to disable. +* `tokens.hs`: A randomly generated token +* `tokens.as`: Another randomly generated token +* `tokens.telegram`: The Telegram bot API token, as generated by @BotFather +* `tokens.google`: A Google API key, used for URL shortening. Can be left out to disable. -`hosts.internal`: The homeserver host to connect to internally. -`hosts.external`: The external domain of the homeserver, used for generating URLs. -`hosts.bare`: Just the (sub)domain of the server. +* `hosts.internal`: The homeserver host to connect to internally. +* `hosts.external`: The external domain of the homeserver, used for generating URLs. +* `hosts.bare`: Just the (sub)domain of the server. -`user_id_format`: A Python `str.format`-style string to format user IDs as -`db_url`: A SQLAlchemy URL for the database. See the [SQLAlchemy docs](http://docs.sqlalchemy.org/en/latest/core/engines.html). +* `user_id_format`: A Python `str.format`-style string to format user IDs as +* `db_url`: A SQLAlchemy URL for the database. See the [SQLAlchemy docs](http://docs.sqlalchemy.org/en/latest/core/engines.html). **Synapse configuration**