Skip to content

Commit

Permalink
add note in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxOhn committed Jul 10, 2024
1 parent 784260f commit 82dad73
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
[![crates.io](https://img.shields.io/crates/v/rosu-v2.svg)](https://crates.io/crates/rosu-v2) [![docs](https://docs.rs/rosu-v2/badge.svg)](https://docs.rs/rosu-v2)

# Temporary note

The osu!api is currently in an exceptionally unstable state regarding data structure due to the shift towards lazer.
Instead of regularly re-publishing a new version, the `rosu-v2/lazer` branch will be kept updated.

To use `rosu-v2`, it is recommended to put the following in your `Cargo.toml`:
```toml
rosu-v2 = { git = "https://github.com/MaxOhn/rosu-v2", branch = "lazer" }
```
Be warned though, breaking changes are likely to occur regularly for the time being.

# rosu-v2

<!-- cargo-rdme start -->
Expand Down

0 comments on commit 82dad73

Please sign in to comment.