Skip to content

Commit 2a3e8de

Browse files
authored
docs: update README.md, change term lyra2 -> lyra (#103)
* docs: update README.md, change term lyra2 -> lyra Update `README.md` to use the Λύρα banner instead of the icon to occupy horizontal space, as well as reformatting some of the sections to improve readability. Also add some cosmetic shield-styled badges and change the `lyra2` terminology usage to `lyra`. * chore: update flake.lock
1 parent 303551c commit 2a3e8de

File tree

6 files changed

+26
-15
lines changed

6 files changed

+26
-15
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
1-
<div align="center">
1+
<p align="center">
2+
<img alt="Λύρα banner" src="assets/lyra-banner.png">
3+
</p>
24

3-
# **Λύρα**
5+
# Λύρα
46

5-
<img src="assets/lyra2-X.png" width="256">
7+
[![Build status](https://github.com/lyra-music/lyra/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/lyra-music/lyra/actions/workflows/ci.yml)
8+
[![GitHub release](https://img.shields.io/github/release/lyra-music/lyra.svg)](https://github.com/lyra-music/lyra/releases/latest)
9+
[![dev chat](https://discordapp.com/api/guilds/1033430025527103568/widget.png?style=shield)](https://discord.gg/d4UerJpvTp)
10+
[![CodeFactor](https://www.codefactor.io/repository/github/lyra-music/lyra/badge)](https://www.codefactor.io/repository/github/lyra-music/lyra)
611

7-
A *featureful*, *self-hostable* **Discord music bot**, made with [`twilight-rs`](https://twilight.rs/) and [`Lavalink`](https://github.com/freyacodes/Lavalink), written in [`Rust`](https://www.rust-lang.org/).
12+
A *self-hostable* **Discord music bot**, focused on *fairness*.
813

9-
</div>
10-
11-
> [!WARNING]
12-
> Still in early development!
14+
> [!NOTE]
15+
> This project is actively developed with a focus on maintaining stability.
16+
> Users are encouraged to self-host and test the bot locally.
17+
> Core functionality is implemented, though some features like queue viewing and polling systems for command fairness are still in development.
1318
1419
## Setup
1520

@@ -106,3 +111,9 @@ Then, clone the repository and run the following command:
106111
```console
107112
$ cargo run --release
108113
```
114+
115+
## Attributions
116+
117+
- [`twilight-rs`](https://twilight.rs/) - Powerful, flexible, and scalable ecosystem of Rust libraries for the Discord API.
118+
- [`Lavalink`](https://lavalink.dev/) - Standalone audio sending node based on Lavaplayer.
119+
- [`lavalink-rs`](https://gitlab.com/vicky5124/lavalink-rs/) - Lavalink bindings for asynchronous rust discord libraries.
File renamed without changes.

assets/lyra-banner.png

176 KB
Loading

assets/lyra2-X.png

-60.4 KB
Binary file not shown.

flake.lock

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lyra/src/core/banner.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pub fn banner() -> String {
4242
env!("VERGEN_CARGO_OPT_LEVEL"),
4343
];
4444

45-
let rdr = include_str!("../../../assets/lyra2-ascii.ans");
45+
let rdr = include_str!("../../../assets/lyra-ascii");
4646
let mut wtr = Vec::new();
4747

4848
let ac = AhoCorasick::new(metadata_patterns).expect("METADATA_PATTERNS must be valid");

0 commit comments

Comments
 (0)