Skip to content

Add-a-README-card.md

Latest commit

 

History

History
50 lines (30 loc) · 3.85 KB

Add-a-README-card.md

File metadata and controls

50 lines (30 loc) · 3.85 KB
Raw

Add a README card

The hosted card puts your now-playing on a GitHub README without opening your media server to the internet. The app on your PC pushes a small update to the card service; the service never connects back to you.

It's off until you turn it on.

Steps

  1. Open the nowplaying Settings page (tray icon, Settings) and choose a style under Appearance → Card Settings. Press Save, then open Sharing → Hosted Card Settings.

  2. Tick Upload my card to the hosted service. For album covers and posters, also tick Include cover art. Press Save. Settings shows an upload state, a per-PC card link with a random ID and a ready-made README snippet. Want one card shared by all your PCs? Sign in with GitHub in Settings > Spotify and hosted card - see below.

  3. Press Copy beside README and paste that exact snippet into your README. A GitHub-linked card might look like:

    ![Now playing](https://nowplaying-hosted.vercel.app/u/your-github-username.svg)

  4. Play something on your media server. Your card updates within a few seconds.

Success looks like: the card image on your README shows what's playing.

One card for all your PCs (optional GitHub sign-in)

By default each PC gets its own card link with a random ID. If you have more than one PC, sign in to share one card:

  1. Open Settings > Spotify and hosted card > Hosted card from the tray, check the card service address, and choose Sign in with GitHub. This works on the first-run page or later in Settings; there is no separate setup wizard to reopen.
  2. Open the GitHub link shown and enter the code. GitHub only tells nowplaying your username - no other permissions.
  3. Your card link becomes https://nowplaying-hosted.vercel.app/u/<your-username>.svg. Sign in on each PC; whichever is playing updates the card.

Settings > Hosted card devices lists the PCs signed in as you. You can rename one, sign one out, or Sign out everywhere (the card stops updating until you sign in again).

What the card shows

  • Playing cards say "Now playing"; paused cards say "Paused". Music shows the track and artist, and TV episodes show the episode name and series when available. Detailed season and episode numbers stay on your PC.
  • Paused media retains its title. Idle or expired updates show nothing playing.
  • Studio uses full-bleed artwork, Editorial pairs a large cover with warm paper and serif type, and Hi-Fi uses a record display with an amber timeline. Classic, Paper and Compact are also available.
  • Choose one of six styles in Settings > Appearance, adjust the width, and press Save. Copy the updated README snippet from Sharing after an appearance change; the style is part of its URL. Style gallery.

Privacy

You choose what the card can ever receive. With a media type hidden or privacy set to private, the card only ever gets "nothing playing". Your server address and username never leave your PC. Include cover art optionally shares a small image; artwork URLs are never sent. Full detail: Privacy and safe configuration and what leaves your PC.

If the README looks stale

GitHub fetches README images through its own cache, so a fresh card can take a while to appear there even when the origin has updated. Open your card link directly: if it's fresh there, the card service is fine and you just need to wait.

Stop playing or close the app and the card goes back to "Not playing" within about ten minutes.

Turning it off

Disconnect this PC in the hosted card section deletes this PC's state and device key on the service and on your PC. With GitHub sign-in your other PCs keep updating the card; without it, the card link stops showing anything.