Create config.md

This commit is contained in:
Jeremy 2022-04-19 02:52:42 +00:00 committed by GitHub
parent f62bd47554
commit 21cfb78614
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

23
config.md Normal file
View file

@ -0,0 +1,23 @@
# Configuration
This file will list all the possible configuration directives and statements.
Comments can be made in the file with a hashtag (`#`).
---
## Directives
Options you can modify with an argument.
* `Homeserver`: The homeserver to log into
* `Username`: The user's name used to log in
* `Password`: The user's password used to log in
* `AccessToken`: A custom access token to use for logging in, instead of generating a new one from login credentials
* `CacheLocation`: A custom location to cache access tokens in. Defaults to $HOME/.cache
## Statements
Options that say one thing and nothing else. You can't change these.
* `Colour`/`Color`: Use colour
* `NoCache`: Don't cache access tokens