From 3a43681ae8f66a4b8f1bc62b219d04c34d2d5e52 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franti=C5=A1ek=20Boh=C3=A1=C4=8Dek?= Date: Sat, 8 Jul 2023 12:13:38 +0200 Subject: [PATCH] docs: add basic README --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a7bb392 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Mpris ctl +A cli tool for managing media players using DBus Mpris2. +This repository consists of two programs, +the daemon and the cli. + +The daemon looks for a player that is currently active +and the cli will use that as default target. + +The cli may play, pause, toggle the target player. +If the daemon is not running, first player that is found will be used. +It may also skip songs and show metadata about the media currently playing. + +## Usage +``` sh +> mpris-ctl +Manage dbus mpris2 players + +Usage: mpris-ctl [OPTIONS] + +Commands: + play Send play media command + pause Send pause media command + toggle Send play if paused, else send pause + prev Switch to previous media/song + next Switch to next media/song + metadata Obtain metadata of the currently playing media + status Obtain status of the currently active player + help Print this message or the help of the given subcommand(s) + +Options: + --all-players + --active-players + --player + -h, --help Print help + -V, --version Print version +``` + +` + +## Motivation +I am making this tool mainly for learning Rust. If you want a program that does all +this one does, plus more, use [playerctl](https://github.com/altdesktop/playerctl). -- 2.48.1