From 9e0d8c0117c4fa2c85d4b8beef5c83b5cb2ebefe Mon Sep 17 00:00:00 2001 From: h7x4 Date: Sat, 3 Aug 2024 15:52:41 +0200 Subject: [PATCH] README: small fixups, add fork notice --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 89d797f..b85d402 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,17 @@ # mpvipc +> **NOTE:** This is a fork of [gitlab.com/mpv-ipc/mpvipc](https://gitlab.com/mpv-ipc/mpvipc), which introduces a lot of changes to be able to use the library asynchronously with [tokio](https://github.com/tokio-rs/tokio). + +--- + A small library which provides bindings to control existing mpv instances through sockets. ## Dependencies -- `mpv` -- `cargo` (make dependency) -- `cargo-nextest` (test depencency) -- `grcov` (test depencency) +- `mpv` (runtime dependency) +- `cargo-nextest` (optional test depencency) +- `grcov` (optional test depencency) ## Example @@ -29,6 +32,6 @@ use mpvipc::*; async fn main() -> Result<(), MpvError> { let mpv = Mpv::connect("/tmp/mpv.sock").await?; let paused: bool = mpv.get_property("pause").await?; - mpv.set_property("pause", !paused).expect("Error pausing"); + mpv.set_property("pause", !paused).await.expect("Error pausing"); } ``` \ No newline at end of file