Skip to content

Commit

Permalink
Made README much more fancy
Browse files Browse the repository at this point in the history
  • Loading branch information
Xithrius committed Jul 10, 2023
1 parent 5177bc0 commit 16958d8
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
<p align="center">
<img src="images/icon.png" alt="Project icon"/>
</p>
# Xythrion

<h1 align="center">Xythrion</h1>
<h3 align="center">Discord graphing bot</h3>
<img align="left" src="images/icon.png" width=128/>

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
Expand All @@ -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.
Expand Down

0 comments on commit 16958d8

Please sign in to comment.