diff --git a/config.md b/config.md new file mode 100644 index 0000000..1411f4a --- /dev/null +++ b/config.md @@ -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