Skip to content

Commit

Permalink
Bump version to 1.5 and fix README.
Browse files Browse the repository at this point in the history
  • Loading branch information
ray-kast committed Feb 28, 2022
1 parent bafc9d4 commit d6eac92
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 16 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "empress"
version = "1.4.2"
version = "1.5.0"
authors = ["rookie1024 <[email protected]>"]
edition = "2021"
description = "A D-Bus MPRIS daemon for controlling media players."
Expand Down
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ This tool functions as a simple command-line abstraction over the D-Bus [MPRIS
specification](https://specifications.freedesktop.org/mpris-spec/latest/) which
allows for querying and controlling media players. It functions similarly to
[playerctl](https://github.com/altdesktop/playerctl/), but features more basic
controls and a more complex method of tracking which player you want to control.
`empress` uses its own D-Bus daemon to keep track of which players are currently
playing (and which players have been updated the most recently), and uses this
information to decide you want to pause Spotify rather than playing a minimized
YouTube video.
controls and a more complex method of tracking which player you want to
control. `empress` uses its own D-Bus daemon to keep track of which players are
currently playing (and which players have been updated the most recently), and
uses this information to determine you wanted to pause Spotify rather than
playing a minimized YouTube video.

## Installation

Expand All @@ -31,23 +31,22 @@ put this in an rcfile (or see below for setting up a service):
$ empress server
```

The server will gracefully shut down if interrupted or signalled with `SIGTERM`.

**NOTE:** If you install the D-Bus service below, an `empress` daemon will
automagically spawn when any of the client commands below are executed.
The server will gracefully shut down if interrupted or signaled with `SIGTERM`.

## Usage

Once you have the daemon running (or you enable autostart below), you can
communicate with it using one of several subcommands, e.g.:
Once you have the daemon set up, you can communicate with it using one of
several subcommands, e.g.:

```sh
$ empress play-pause
```

The current list of commands includes, `next`, `previous`, `pause`,
`play-pause`, `stop`, and `play`, which all function as you would expect. For
more help you can always run `empress help`.
Empress has commands for basic player operations (e.g. `now-playing`,
`play`/`pause`/`play-pause`/`stop`, `next`/`previous`/`seek`, `volume`), as
well as several utility subcommands for more advanced operation (such as
`list-players` and `switch-current`). To see the list of commands at any time
or get help for a particular command simply run `empress help`.

## Installing `empress` as a Service

Expand All @@ -66,6 +65,9 @@ If you want to make a system-wide installation, simply omit the `-l` flag. This
will install the session service files into `/usr` instead (but note that
`empress` **never** runs as a D-Bus system bus).

Once `empress` has been installed as a service, running any of the `empress`
client commands listed above will autostart the daemon.

### Uninstalling

To remove installed service definitions, simply run:
Expand Down

0 comments on commit d6eac92

Please sign in to comment.