Minor formatting edits in README
This commit is contained in:
parent
708f227708
commit
ca2732b755
|
@ -2,13 +2,15 @@
|
||||||
|
|
||||||
This is a simple broker that watches a ListenBrainz now-playing status and sends it to Discord RPC.
|
This is a simple broker that watches a ListenBrainz now-playing status and sends it to Discord RPC.
|
||||||
|
|
||||||
## Usage as standalone application
|
> **NOTE:** An account on ListenBrainz will be required to use this broker.
|
||||||
|
|
||||||
> **NOTE:** This project has not been tested on Linux but should work with minimal changes. The Windows service functionality will not work on Linux.
|
## Usage as standalone application
|
||||||
|
|
||||||
The project can be run directly by simply running `dotnet run` in the project directory. This will start the broker and begin sending now-playing status to Discord RPC.
|
The project can be run directly by simply running `dotnet run` in the project directory. This will start the broker and begin sending now-playing status to Discord RPC.
|
||||||
You can also start the executable directly from the binary output directory; note that a valid configuration file must be present in the same directory as the executable.
|
You can also start the executable directly from the binary output directory; note that a valid configuration file must be present in the same directory as the executable.
|
||||||
|
|
||||||
|
> **NOTE:** This project has not been tested on Linux but should work with minimal changes. The Windows service functionality will not work on Linux.
|
||||||
|
|
||||||
## Installation as a Windows Service
|
## Installation as a Windows Service
|
||||||
|
|
||||||
Alternatively, this project uses Topshelf to install as a Windows service. To install it, run the following command (as administrator):
|
Alternatively, this project uses Topshelf to install as a Windows service. To install it, run the following command (as administrator):
|
||||||
|
@ -44,9 +46,8 @@ Explanation of the fields:
|
||||||
|
|
||||||
## Scrobbling
|
## Scrobbling
|
||||||
|
|
||||||
**An account on ListenBrainz will be required to use this broker.**
|
|
||||||
|
|
||||||
This broker does not scrobble tracks to ListenBrainz. If you want to scrobble tracks, here are some suggestions:
|
This broker does not scrobble tracks to ListenBrainz. If you want to scrobble tracks, here are some suggestions:
|
||||||
- [Web Scrobbler for Firefox](https://addons.mozilla.org/en-US/firefox/addon/web-scrobbler/) - A browser extension that scrobbles tracks from various sources. Recommend configuring to ignore media that is not categorised as music.
|
- [Web Scrobbler for Firefox](https://addons.mozilla.org/en-US/firefox/addon/web-scrobbler/) - A browser extension that scrobbles tracks from various sources. Recommend configuring to ignore media that is not categorised as music.
|
||||||
- [jellyfin-plugin-listenbrainz](https://github.com/lyarenei/jellyfin-plugin-listenbrainz) - A Jellyfin plugin that scrobbles tracks from Jellyfin to ListenBrainz.
|
- [jellyfin-plugin-listenbrainz](https://github.com/lyarenei/jellyfin-plugin-listenbrainz) - A Jellyfin plugin that scrobbles tracks from Jellyfin to ListenBrainz.
|
||||||
|
|
||||||
For more suggestions, see the [official ListenBrainz website](https://listenbrainz.org/add-data/).
|
For more suggestions, see the [official ListenBrainz website](https://listenbrainz.org/add-data/).
|
Loading…
Reference in New Issue