From 185b2f5589edc28d5faed55ac90b604872ebba98 Mon Sep 17 00:00:00 2001
From: Xevion <xevion@xevion.dev>
Date: Fri, 1 Nov 2024 16:58:55 -0500
Subject: [PATCH] Fixed blockquote alerts in README, mild reformatting

---
 CHANGELOG.md |  5 +++++
 README.md    | 28 +++++++++++++++-------------
 2 files changed, 20 insertions(+), 13 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index c1db103..b1d4ef5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,8 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Mildly reformatted `README.md`
 - A development mode check for the `app.state.ip_pool`'s initialization (caused application failure in production only)
 
+### Fixed
+
+- Improper formatting of blockquote Alerts in `README.md`
+
 ## [0.2.0] - 2024-11-01
 
 ### Added
diff --git a/README.md b/README.md
index c44b333..a05ee5a 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,8 @@ asdf install
 
 This installs the version of Node.js specified in [`.tool-versions`](.tool-versions).
 
->[!NOTE] If you use Node.js for other projects, you may want to install the version you need & set it as the global version via `asdf global nodejs <version>` or `asdf install nodejs latest:<version>`. If you don't care, `asdf install latest nodejs` also works.
+> [!NOTE]
+> If you use Node.js for other projects, you may want to install the version you need & set it as the global version via `asdf global nodejs <version>` or `asdf install nodejs latest:<version>`. If you don't care, `asdf install latest nodejs` also works.
 
 2. Install `pnpm` with `npm install -g pnpm`
 3. `cd frontend`
@@ -48,17 +49,17 @@ This installs the version of Node.js specified in [`.tool-versions`](.tool-versi
 ### Backend
 
 1. Install [`pyenv`][pyenv] or [`pyenv-win`][pyenv-win]
-    
-    - Install Python 3.12 (`pyenv install 3.12`)
+
+   - Install Python 3.12 (`pyenv install 3.12`)
 
 2. Install `poetry`
 
-    - Requires `pipx`, see [here][pipx]. You will NOT have this by default. This is NOT `pip`, do not install either with `pip`.
-    - Install with `pipx install poetry`
+   - Requires `pipx`, see [here][pipx]. You will NOT have this by default. This is NOT `pip`, do not install either with `pip`.
+   - Install with `pipx install poetry`
 
 3. Install backend dependencies with `poetry install`.
 4. Start the backend server with `./run.sh`
-5. (*optional*) Install the [Railway CLI][railway]
+5. (_optional_) Install the [Railway CLI][railway]
    - Fastest installation is via shell: `bash <(curl -fsSL cli.new)`
      - Alternatives found [here][railway].
    - This will let us skip creating a local `.env` file, as well as keeping your database URL synchronized.
@@ -66,15 +67,16 @@ This installs the version of Node.js specified in [`.tool-versions`](.tool-versi
 
 ## Usage
 
-A full stack (*frontend* and *backend*), automatically reloading project is possible, but it requires two terminals.
-  
+A full stack (_frontend_ and _backend_), automatically reloading project is possible, but it requires two terminals.
+
 1. Open a terminal in each respective directory (`/backend` and `/frontend`).
 2. Execute `./run.sh` to start the development server for each.
-    - For the backend, you'll either need to have the `railway` CLI installed or a `.env` file with the database URL.
-      - See [`.env.example`](backend/.env.example) for a list of all available environment variables.
-    - For the frontend, the defaults are already sufficient.
+   - For the backend, you'll either need to have the `railway` CLI installed or a `.env` file with the database URL.
+     - See [`.env.example`](backend/.env.example) for a list of all available environment variables.
+   - For the frontend, the defaults are already sufficient.
 
->[!WARNING] The `run.sh` scripts provide default environment variables internally; if you want to run the commands manually, you'll need to provide them to `.env` files or the command line.
+> [!WARNING]
+> The `run.sh` scripts provide default environment variables internally; if you want to run the commands manually, you'll need to provide them to `.env` files or the command line.
 
 [peewee]: https://docs.peewee-orm.com/en/latest/
 [railway]: https://docs.railway.app/guides/cli
@@ -89,4 +91,4 @@ A full stack (*frontend* and *backend*), automatically reloading project is poss
 [wsl]: https://docs.microsoft.com/en-us/windows/wsl/install
 [pipx]: https://pipx.pypa.io/stable/installation/
 [pyenv]: https://github.com/pyenv/pyenv
-[pyenv-win]: https://github.com/pyenv-win/pyenv-win
\ No newline at end of file
+[pyenv-win]: https://github.com/pyenv-win/pyenv-win