From 66fc66247c1d296d298d4bc707e21e9fa9440da3 Mon Sep 17 00:00:00 2001 From: kzndotsh Date: Thu, 22 Aug 2024 01:45:57 +0000 Subject: [PATCH] docs(README.md, development.md): update file references from .json to .yml to reflect changes in configuration file format fix(development.md): correct .env.example to .env to accurately represent the environment file name --- README.md | 4 ++-- docs/development.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a082e71..9c6aa33 100644 --- a/README.md +++ b/README.md @@ -110,10 +110,10 @@ Further detailed instructions can be found in the [development guide](docs/devel We offer dev tokens on request in our Discord server. -7. Copy the `config/settings.json.example` file to `config/settings.json` and fill in the required values. +7. Copy the `config/settings.yml.example` file to `config/settings.yml` and fill in the required values. ```bash - cp config/settings.json.example config/settings.json + cp config/settings.yml.example config/settings.yml ``` Be sure to add your Discord user ID to the `BOT_OWNER` key in the settings file. diff --git a/docs/development.md b/docs/development.md index 08c0537..20ba4e6 100644 --- a/docs/development.md +++ b/docs/development.md @@ -50,9 +50,9 @@ The project is structured as follows: ### Configuration -- `.env.example`: The example environment file containing the environment variables required for the bot. +- `.env`: The environment file containing the secret environment variables for the bot. - `config/`: The config directory containing the configuration files for the bot. - - `settings.json`: The settings file containing the bot settings and configuration. + - `settings.yml`: The settings file containing the bot settings and configuration. ### Documentation