minor readme adjustment

This commit is contained in:
MaxOhn
2021-11-21 03:56:32 +01:00
parent 13ef11a1f8
commit bdc2927963
2 changed files with 4 additions and 2 deletions
+3 -1
View File
@@ -4,7 +4,7 @@
A standalone crate to calculate star ratings and performance points for all [osu!](https://osu.ppy.sh/home) gamemodes. A standalone crate to calculate star ratings and performance points for all [osu!](https://osu.ppy.sh/home) gamemodes.
Conversions between gamemodes are generally not supported. Conversions between game modes (i.e. "converts") are generally not supported.
Async is supported through features, see below. Async is supported through features, see below.
@@ -54,6 +54,8 @@ println!("Stars: {} | Max PP: {}", stars, max_pp);
If either the `async_tokio` or `async_std` feature is enabled, beatmap parsing will be async. If either the `async_tokio` or `async_std` feature is enabled, beatmap parsing will be async.
```rust ```rust
use rosu_pp::{Beatmap, BeatmapExt};
// Parse the map asynchronously // Parse the map asynchronously
let map = match Beatmap::from_path("/path/to/file.osu").await { let map = match Beatmap::from_path("/path/to/file.osu").await {
Ok(map) => map, Ok(map) => map,
+1 -1
View File
@@ -1,6 +1,6 @@
//! A standalone crate to calculate star ratings and performance points for all [osu!](https://osu.ppy.sh/home) gamemodes. //! A standalone crate to calculate star ratings and performance points for all [osu!](https://osu.ppy.sh/home) gamemodes.
//! //!
//! Conversions between gamemodes are generally not supported. //! Conversions between game modes (i.e. "converts") are generally not supported.
//! //!
//! Async is supported through features, see below. //! Async is supported through features, see below.
//! //!