diff --git a/README.md b/README.md index 24ccf8d..bf9d703 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ for more information, see https://devins.page/tinysub. for discussion, use the i ## using -you can use my hosted version of tinysub at [tinysub.devins.page](https://tinysub.devins.page). +you can use my hosted build of tinysub at [tinysub.devins.page](https://tinysub.devins.page). you will need to have access to an [OpenSubsonic server](https://opensubsonic.netlify.app/docs/#servers) to use this app of course, as it is an OpenSubsonic client, *not* a local music player. there exist many guides to get one set up. i personally use [Navidrome](https://www.navidrome.org). @@ -24,9 +24,11 @@ i always host the latest version of tinysub at [tinysub.devins.page](https://tin tinysub is just a simple [Vite](https://vite.dev) project. to build it, run `npm install` and `npm run build`. the output will appear in `dist`. -after building, simply serve the output with a web server like Caddy, Nginx, Apache, etc... **IMPORTANT:** [ensure your server is configured properly](https://vite-pwa-org.netlify.app/deployment) for the Vite PWA plugin, or else app updates may not work! +after building, simply serve the output with a web server like Caddy, Nginx, Apache, etc... -if you would like to customize your build, such as adding a prefilled server URL, see `.env.example`. +**IMPORTANT:** [ensure your server is configured properly](https://vite-pwa-org.netlify.app/deployment) for the Vite PWA plugin, or else app updates may not work! + +if you would like to customize your build, such as adding a prefilled server URL or changing the base URL, see `.env.example`. ### the declarative way @@ -40,7 +42,7 @@ if you're using NixOS/nix-darwin/Nix, i also offer a very simple Nix package in Firefox and Safari do not allow mixed `http`/`https`. if you are trying to connect to your server with `http` rather than `https`, it may not work out of the box on non-Chromium-based browsers. -you likely need to serve your Subsonic server on `https`. *if you use Tailscale, consider trying out [Tailscale Serve](https://tailscale.com/docs/features/tailscale-serve), which handles `https` automatically!* +you likely need to serve your Subsonic server on `https`. *use Tailscale? consider trying out [Tailscale Serve](https://tailscale.com/docs/features/tailscale-serve), which handles `https` automatically!* ### mobile support? @@ -52,6 +54,8 @@ looking for alternative clients for mobile devices? on iOS, i heavily recommend not planned, this client is built around the OpenSubsonic API and supporting other media servers would add a lot of unnecessary complexity to the codebase and would be more difficult to maintain. +--- + ## OpenSubsonic extensions - [`apiKeyAuthentication`](https://opensubsonic.netlify.app/docs/extensions/apikeyauth)