summaryrefslogtreecommitdiff
path: root/vendored/mpd/README.md
diff options
context:
space:
mode:
authorJakob L. Kreuze <zerodaysfordays@sdf.org>2022-08-07 20:47:54 -0400
committerJakob L. Kreuze <zerodaysfordays@sdf.org>2022-08-07 20:47:54 -0400
commitea77a8cf9c012fcd877d842fec85b0b5a442952c (patch)
tree7f209c030b97a957497f152d161a9d7035311132 /vendored/mpd/README.md
parent0de7e9ac43f88aae3750ecfe25b5454fdd1ad015 (diff)
Import modifications to `mpd` crateHEADmaster
Diffstat (limited to 'vendored/mpd/README.md')
-rw-r--r--vendored/mpd/README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/vendored/mpd/README.md b/vendored/mpd/README.md
new file mode 100644
index 0000000..0fae261
--- /dev/null
+++ b/vendored/mpd/README.md
@@ -0,0 +1,44 @@
+# rust-mpd <a href="https://travis-ci.org/kstep/rust-mpd"><img src="https://img.shields.io/travis/kstep/rust-mpd.png?style=flat-square" /></a> <a href="https://crates.io/crates/mpd"><img src="https://img.shields.io/crates/d/mpd.png?style=flat-square" /></a> <a href="https://crates.io/crates/mpd"><img src="https://img.shields.io/crates/v/mpd.png?style=flat-square" /></a> <a href="https://crates.io/crates/mpd"><img src="https://img.shields.io/crates/l/mpd.png?style=flat-square" /></a><a href=http://docs.rs/mpd/><img src="https://docs.rs/mpd/badge.svg" /></a>
+
+Pure Rust version of [libmpdclient](http://www.musicpd.org/libs/libmpdclient/).
+
+[Full documentation](http://docs.rs/mpd/)
+
+## Example
+
+Add to `Cargo.toml`:
+
+```toml
+[dependencies]
+mpd = "*"
+```
+
+Then just use:
+
+```rust
+extern crate mpd;
+
+use mpd::Client;
+use std::net::TcpStream;
+
+let mut conn = Client::connect("127.0.0.1:6600").unwrap();
+conn.volume(100).unwrap();
+conn.load("My Lounge Playlist", ..).unwrap();
+conn.play().unwrap();
+println!("Status: {:?}", conn.status());
+```
+
+## License
+
+Licensed under either of
+
+ * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.