Skip to content

Commit 699046f

Browse files
committed
Rework README and banner
1 parent b7a70f4 commit 699046f

File tree

2 files changed

+95
-123
lines changed

2 files changed

+95
-123
lines changed

README.md

Lines changed: 95 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -1,153 +1,125 @@
1+
![Screenshot of the application in the tray menu and the Discord status](
2+
./assets/banner.png)
3+
14
[![Number of downloads](https://img.shields.io/github/downloads/ungive/discord-music-presence/total?style=flat&label=downloads&labelColor=444)](https://github.com/ungive/discord-music-presence/releases)
25
 [![Number of downloads of the latest version](https://img.shields.io/github/downloads/ungive/discord-music-presence/latest/total?style=flat&label=downloads%20%40latest&labelColor=444)](https://github.com/ungive/discord-music-presence/releases)
36
 
47
[![Join the Discord server](https://img.shields.io/discord/1224509771068211292?logo=discord&logoColor=eee&label=Discord&labelColor=464ce5&color=fff&cacheSeconds=43200)](https://discord-invite.musicpresence.app)
58
 
69
[![Support Music Presence on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dmusicpresence%26type%3Dpatrons&style=social)](https://patreon.com/musicpresence)
710

8-
# Music Presence for Discord
9-
10-
![Screenshot of the application in the tray menu and the Discord status](
11-
./assets/banner.png)
12-
13-
Music Presence allows you to show your friends what you are listening to,
14-
no matter which media player or streaming service you are using.
15-
It works by observing which media players are playing music on your device
16-
and showing the information as a Discord activity.
17-
18-
The most notable features include:
19-
20-
- Fine-grained control over which applications are shared
21-
in your Discord status.
22-
- Supports numerous music players and streaming services
23-
(support for more is being worked on!)
24-
- The tray icon changes and reflects whether your status is currently active or not!
25-
- Shows the streaming service or media player you are using in your status.
26-
- Shows a button in the status that allows others to open a link the song
27-
(only for TIDAL right now).
28-
- Shows the exact playback position, if the media player supports it.
29-
- Controls are easily accessible via the tray menu.
30-
31-
## Supported media players
32-
33-
The following media players will be detected
34-
and shared in your Discord status:
35-
36-
<span><a href="https://tidal.com"><img title="TIDAL" alt="" height="48" src="https://live.musicpresence.app/v2/tidal.ico"></a></span>&nbsp;
37-
<span><a href="https://www.qobuz.com"><img title="Qobuz" alt="" height="48" src="https://live.musicpresence.app/v2/qobuz.ico"></a></span>&nbsp;
38-
<span><a href="https://spotify.com"><img title="Spotify" alt="" height="48" src="https://live.musicpresence.app/v2/spotify.ico"></a></span>&nbsp;
39-
<span><a href="https://www.deezer.com"><img title="Deezer" alt="" height="48" src="https://live.musicpresence.app/v2/deezer.ico"></a></span>&nbsp;
40-
<span><a href="https://www.amazon.com/music"><img title="Amazon Music" alt="" height="48" src="https://live.musicpresence.app/v2/amazon-music.ico"></a></span>&nbsp;
41-
<span><a href="https://www.foobar2000.org"><img title="foobar2000" alt="" height="48" src="https://live.musicpresence.app/v2/foobar2000.ico"></a></span>&nbsp;
42-
<span><a href="https://www.getmusicbee.com"><img title="MusicBee" alt="" height="48" src="https://live.musicpresence.app/v2/musicbee.ico"></a></span>&nbsp;
43-
<span><a href="https://music.apple.com"><img title="Apple Music" alt="" height="48" src="https://live.musicpresence.app/v2/apple-music.ico"></a></span>&nbsp;
44-
<span><a href="https://en.wikipedia.org/wiki/Windows_Media_Player_(2022)"><img title="Windows Media Player" alt="" height="48" src="https://live.musicpresence.app/v2/windows-media-player.ico"></a></span>&nbsp;
45-
<span><a href="https://th-ch.github.io/youtube-music/"><img title="YouTube Music (Unofficial Desktop)" alt="" height="48" src="https://live.musicpresence.app/v2/youtube-music.ico"></a></span>&nbsp;
46-
&ensp;*and more...*
47-
48-
This is only a selection of supported media players.
49-
For a table of all players
50-
and how well they are supported on each operating system,
51-
please refer to [PLAYERS.md](./PLAYERS.md).
52-
53-
If your media player is not listed or detected, please
54-
[suggest it](#my-media-player-is-not-detected),
55-
as described below!
56-
57-
## Download
58-
59-
For downloads visit the
60-
**[Releases](https://github.com/ungive/discord-music-presence/releases)**
61-
page.
62-
You can currently download Music Presence for **Windows** and **Mac**.
63-
Support for **Linux** is underway
64-
and will be added in a future update!
65-
66-
## Join the Discord server
67-
68-
Feel free to join the Discord server to stay in touch!
69-
70-
- **[Open the invite](https://discord-invite.musicpresence.app)**
71-
72-
## Donations
73-
74-
The development of this project largely depends
75-
on the effort of a single developer,
76-
who is working on this application in his free-time.
77-
If you would like to support the development progress
78-
or would simply like to show your appreciation,
79-
you can do so by making a donation.
80-
Thank you!
81-
82-
- **[Patreon](https://patreon.com/musicpresence)**
83-
&nbsp;&ndash;&nbsp; *the preferred option with
84-
[additional benefits](https://www.patreon.com/musicpresence/membership)*
85-
- **[GitHub Sponsors](https://github.com/sponsors/ungive)**
86-
- **[LiberaPay](https://liberapay.com/jonasvandenberg)**
11+
**Music Presence** shows your friends on Discord
12+
what music you are listening to.
8713

88-
For more information, check [FUNDING.md](./FUNDING.md).
14+
It works with any media player, be that Spotify, TIDAL or foobar2000.
15+
When you play music with an app, it is automatically detected
16+
and appears in the tray menu, as you can see in the screenshot above!
8917

90-
## My media player is not detected
18+
These are some of the most notable features
9119

92-
> The application is still in early development.
93-
> If your media player is not detected, simply follow the steps outlined here
94-
> to request support for your media player or streaming service.
20+
- Shows the **correct album cover 100% of the time** for every media player,
21+
no missing covers
22+
- Shows the exact current playback position, if the media player supports it
23+
- Fine-grained control over which applications are shared and which are not
24+
- The tray icon changes and reflects
25+
whether your status is currently active or not
9526

96-
To report that a media player is not detected:
27+
You can download Music Presence
28+
[**here**](https://github.com/ungive/discord-music-presence/releases/latest)
9729

98-
1. In the tray menu, navigate to "Help"
99-
and click on "My media player is not detected".
100-
2. A new GitHub issue will open in your browser.
101-
3. Please describe which media player is not detected and submit the form.
102-
103-
The issue will be filled out with some information about your system.
104-
This will help me add support for the media player that you are requesting.
105-
Once you have submitted the issue, I will come back to you as soon as I can!
106-
107-
## Integrating with Music Presence
108-
109-
Are you interested in integrating
110-
your application or service with Music Presence?
111-
112-
The plan is to allow our users to integrate external services
113-
in order to **stream real-time playback information of currently playing music**
114-
not only to Discord, but **anywhere they want**.
30+
---
11531

116-
Read more [here](./INTEGRATION.md).
32+
[**Download**](https://github.com/ungive/discord-music-presence/releases/latest)
33+
&nbsp;&bullet;&nbsp;
34+
[**Discord**](https://discord.com/invite/7rc8dWD4ug)
35+
&nbsp;&bullet;&nbsp;
36+
[**Patreon**](https://patreon.com/musicpresence)
37+
&nbsp;&bullet;&nbsp;
38+
[**Documentation**](./documentation/README.md)
39+
&nbsp;&bullet;&nbsp;
40+
[**Changelog**](./CHANGELOG.md)
41+
&nbsp;&bullet;&nbsp;
42+
[**Roadmap**](./ROADMAP.md)
43+
&nbsp;&bullet;&nbsp;
44+
[**Privacy**](./PRIVACY.md)
11745

11846
---
11947

120-
## Privacy
48+
## Features
49+
50+
- Music Presence works with *any* media player!
51+
- Shows the correct album cover image 100% of the time!
52+
*This works with any media player
53+
and is achieved without the use of external image sources.*
54+
- Fine-grained control
55+
over which applications are shared in your status
56+
- Fine-grained control over the appearance of your status
57+
- Shows the exact playback position, if the media player supports it
58+
- Option to switch between the "Listening to"
59+
and "Playing" activity type with one click
60+
- Option to switch between the player name
61+
and "Music" as the activity name with one click
62+
*This means you can either have it show "Listening to Music"
63+
or e.g. "Listening to TIDAL"*
64+
- Shows the logo of the media player or streaming service
65+
that is playing your music in your status
66+
- In-app and automatic updates of Music Presence,
67+
so you don't have to install new versions by downloading them manually.
68+
In addition to that you're always informed
69+
about any changes and additions with an informational popup
70+
- The tray icon changes and reflects the current state of Music Presence,
71+
i.e. whether it is currently sharing media in your status,
72+
whether it's waiting for media playback
73+
or if it has been disabled by you entirely
74+
- For TIDAL users:
75+
- Shows a "Listen to this song" button
76+
- Shows all additional artists, not just the main one
77+
78+
## Further links
79+
80+
- [Supported media players](https://github.com/ungive/discord-music-presence/blob/master/documentation/supported-media-players.md)
81+
- [What if my media player is not detected?](https://github.com/ungive/discord-music-presence/blob/master/documentation/supported-media-players.md#my-media-player-is-not-detected-)
82+
- [Integrating with Music Presence for third-parties](https://github.com/ungive/discord-music-presence/blob/master/documentation/third-party-integration.md)
83+
- [Verifying your download]([./documentation/](https://github.com/ungive/discord-music-presence/blob/master/documentation/automatic-updates.md#verifying-releases))
12184

122-
For detailed information on which data Music Presence collects
123-
and to which services the data is sent,
124-
please read [`PRIVACY.md`](./PRIVACY.md)
125-
or click on "Privacy Notice" in the "Help" menu of the application.
126-
127-
## Roadmap
85+
## Donations
12886

129-
For an overview of features that are being worked on,
130-
please read [ROADMAP.md](./ROADMAP.md).
87+
The development of this project solely depends
88+
on the effort of a single developer.
89+
Your financial support allows me to invest more of my time into this project
90+
and helps cover recurring server and domain costs,
91+
which ultimately helps in making improvements
92+
and working on [new features](./ROADMAP.md) that are waiting to be implemented!
13193

132-
## Changelog
94+
Any donation is highly appreciated. Thank you!
13395

134-
For information about changes with each version
135-
read the [CHANGELOG.md](./CHANGELOG.md) file.
96+
* **[Patreon](https://www.patreon.com/musicpresence)**
97+
&nbsp;&ndash;&nbsp; membership with additional perks
98+
* **[LiberaPay](https://liberapay.com/jonasvandenberg)**
99+
&nbsp;&ndash;&nbsp; option to donate anonymously
100+
* **[GitHub Sponsors](https://github.com/sponsors/ungive)**
101+
&nbsp;&ndash;&nbsp; option for one-time donations, directly here on GitHub
136102

137-
## License
103+
You can read [**here**](./FUNDING.md) for more information.
138104

139-
This project is licensed under the Music Presence license.
140-
For more information read the [LICENSE.txt](./LICENSE.txt) file.
105+
## Community
141106

142-
## Legacy source code
107+
Our community is slowly growing
108+
over on our [**Discord**](https://discord.com/invite/7rc8dWD4ug) server!
143109

144-
For the source code of versions prior to version 2.0.0,
145-
please visit the repository for the
146-
[legacy source code](https://github.com/ungive/tidal-discord-presence).
110+
If you ever encounter an issue, have a question
111+
or simply want to chat with me and other users of Music Presence,
112+
you are more than welcome to swing by.
113+
I'm usually very active there
114+
and I try to respond to message as swiftly as I can.
147115

148116
## Disclaimer
149117

150118
- This software is **not** affiliated with or endorsed by Discord.
151119
- This software is **not** affiliated with or endorsed by
152120
any streaming service, media player or company that distributes music,
153-
including but not limited to those mentioned above.
121+
including but not limited to those displayed within the Music Presence app.
122+
123+
---
124+
125+
Copyright (c) 2024 Jonas van den Berg

assets/banner.png

1.19 MB
Loading

0 commit comments

Comments
 (0)