chore: bump version to 5.0.0 and drop the WIP warnings from the README
This commit is contained in:
+1
-1
@@ -3,7 +3,7 @@ members = ["soulseek-rs-lib", "soulseek-rs"]
|
||||
resolver = "2"
|
||||
|
||||
[workspace.package]
|
||||
version = "0.3.0"
|
||||
version = "5.0.0"
|
||||
authors = ["Michel de Graaf"]
|
||||
edition = "2024"
|
||||
license = "MIT"
|
||||
|
||||
@@ -1,8 +1,6 @@
|
||||
# Soulseek-rs 🦀
|
||||
|
||||
## ⚠️WARNING THIS IS UNDER DEVELOPMENT AND NOT READY FOR USE ⚠️
|
||||
|
||||
Souleek-rs is an experimental Soulseek library and client built in Rust. It's
|
||||
Souleek-rs is a Soulseek library and client built in Rust. It's
|
||||
under development and not yet ready for use. Soulseek is a closed-source P2P
|
||||
file-sharing network from the 2000s. It's still used by music enthusiasts
|
||||
around the world to share niche music.
|
||||
@@ -18,8 +16,6 @@ since the early 2000s, so it's close to my heart, and the Soulseek protocol is
|
||||
a closed-source network protocol that provides a great opportunity to learn
|
||||
about asynchronous and concurrent network programming and reverse engineering
|
||||
|
||||
It's not intended to be a production-ready client (yet).
|
||||
|
||||
Since it's a learning project, I have a self-imposed restriction not to use
|
||||
external dependencies in the library. This means I can't use any external
|
||||
crates that are not part of the Rust standard library. This is a good challenge
|
||||
@@ -30,15 +26,6 @@ experience. For me, this is a good balance between learning and practicality.
|
||||
|
||||
## Planned Features
|
||||
|
||||
- [x] Search for files
|
||||
- [x] Download files
|
||||
- [x] Configure credentials
|
||||
- [x] TUI for searching and downloading files
|
||||
- [x] Configure download & upload directories
|
||||
- [x] Share files
|
||||
- [x] Browse user(s) files
|
||||
- [x] Chat in chatrooms
|
||||
- [x] Private messaging
|
||||
- [ ] Headless mode daemon mode with remote control
|
||||
|
||||
## Project Structure
|
||||
@@ -80,7 +67,7 @@ To build your own Soulseek client, add to your `Cargo.toml`:
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
soulseek-rs-lib = "0.1.0"
|
||||
soulseek-rs-lib = "5.0.0"
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -17,7 +17,7 @@ path = "src/main.rs"
|
||||
workspace = true
|
||||
|
||||
[dependencies]
|
||||
soulseek-rs-lib = { version = "0.3.0", path = "../soulseek-rs-lib" }
|
||||
soulseek-rs-lib = { version = "5.0.0", path = "../soulseek-rs-lib" }
|
||||
|
||||
clap = { version = "4.6.2", features = ["derive", "color", "wrap_help", "env"] }
|
||||
ratatui = "0.30.2"
|
||||
|
||||
Reference in New Issue
Block a user