From 16958d89b53330d32f5a7a532216dcac15c93e10 Mon Sep 17 00:00:00 2001 From: Xithrius Date: Mon, 10 Jul 2023 00:52:46 -0700 Subject: [PATCH] Made README much more fancy --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 994998d..eaf9a95 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,22 @@ -

- Project icon -

+# Xythrion -

Xythrion

-

Discord graphing bot

+ + +A graphing bot, built with [`discord.py`](https://github.com/Rapptz/discord.py). + +[![MIT][s1]][l1] [![CI][s2]][l2] [![pre-commit.ci status][s3]][l3] [![lines of code][s4]][l4] + +[s1]: https://img.shields.io/badge/License-MIT-blue.svg +[l1]: https://opensource.org/licenses/MIT +[s2]: https://github.com/Xithrius/Xythrion/actions/workflows/ci.yml/badge.svg +[l2]: https://github.com/Xithrius/Xythrion/actions/workflows/ci.yml +[s3]: https://results.pre-commit.ci/badge/github/Xithrius/Xythrion/main.svg +[l3]: https://results.pre-commit.ci/latest/github/Xithrius/Xythrion/main +[s4]: https://tokei.rs/b1/github/Xithrius/Xythrion?category=code +[l4]: https://github.com/Xithrius/Xythrion # Requirements -- Python 3.10 +- Python 3.11 - [`python-pdm`](https://github.com/pdm-project/pdm) ## Optional Requirements @@ -18,7 +28,7 @@ ## Local Installation 1. Place your key in `BOT_TOKEN` in the `.env` file. 2. (For development) Install pre-commit hooks using `pdm precommit`. -3. Run `pdm bot` to run the bot, and `pdm api` to start the api. +3. Run `pdm api` to start the api, and `pdm bot` to run the bot. ## Docker/Podman Installation 1. Place your key in `BOT_TOKEN` in the `.env` file.