docs: update README.md [skip ci]

This commit is contained in:
Jagandeep Brar
2022-03-18 14:43:08 -04:00
parent fa740f8473
commit 5b72ff9ca6
2 changed files with 16 additions and 13 deletions

2
.vscode/cspell.json vendored
View File

@@ -28,7 +28,9 @@
"fanart",
"fastlane",
"Fluro",
"Gitbook",
"hardlink",
"Hellonext",
"keychain",
"leechers",
"Lidarr",

View File

@@ -1,7 +1,7 @@
# <img width="40px" src="./assets/images/branding_logo.png" alt="LunaSea"></img>&nbsp;&nbsp;LunaSea
[![App Store](https://img.shields.io/badge/%20Download-iOS-red?logo=app-store&color=%232196F3&logoColor=white&style=flat)](https://www.lunasea.app/appstore)
[![Play Store](https://img.shields.io/badge/%20Download-Android-red?logo=google-play&color=%234CAF50&logoColor=white&style=flat)](https://www.lunasea.app/playstore)
[![App Store](https://img.shields.io/badge/%20download-iOS-red?logo=app-store&color=%232196F3&logoColor=white&style=flat)](https://www.lunasea.app/appstore)
[![Play Store](https://img.shields.io/badge/%20download-Android-red?logo=google-play&color=%234CAF50&logoColor=white&style=flat)](https://www.lunasea.app/playstore)
[![License](https://img.shields.io/github/license/JagandeepBrar/LunaSea?style=flat)](https://github.com/JagandeepBrar/LunaSea/blob/production/LICENSE)
LunaSea is a fully featured, open source self-hosted controller focused on giving you a seamless experience between all of your self-hosted media software remotely on your devices. LunaSea currently supports:
@@ -16,20 +16,23 @@ LunaSea is a fully featured, open source self-hosted controller focused on givin
- [Tautulli](https://github.com/Tautulli/Tautulli)
- [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN)
LunaSea even comes with support for multiple instances of applications using profiles, backing up and restoring your configuration to your filesystem, an AMOLED black theme, and more!
LunaSea even comes with support for webhook-based push notifications, multiple instances of applications using profiles, backup and restore functionality for your configuration, an AMOLED black theme, and more!
> Please note that LunaSea is purely a remote control application, it does not offer any functionality without software installed on a server/computer.
## Releases
Production releases for all platforms are also available on [GitHub](https://github.com/JagandeepBrar/LunaSea/releases).
- [Android](https://www.lunasea.app/playstore)
- [iOS](https://www.lunasea.app/appstore)
- [macOS](https://formulae.brew.sh/cask/lunasea)
> Interested in using prerelease builds of LunaSea? Learn the differences between all the build tracks and how to join one [here](https://www.lunasea.app/testflight)!
## Getting Started
- [Releases](https://github.com/JagandeepBrar/LunaSea/releases)
- [(Android) Play Store](https://www.lunasea.app/playstore)
- [(iOS) App Store](https://www.lunasea.app/appstore)
- [(macOS) GitHub](https://github.com/JagandeepBrar/LunaSea/releases)
- [(macOS) Homebrew](https://formulae.brew.sh/cask/lunasea)
- [Build Guide](https://github.com/JagandeepBrar/LunaSea/wiki/Build-Guide)
- [(Android) Keystore Setup](https://github.com/JagandeepBrar/LunaSea/wiki/Configure-Keystore)
- [(iOS) Development Certificate Setup](https://github.com/JagandeepBrar/LunaSea/wiki/Setup-of-Development-Certificate)
- [Documentation](https://www.lunasea.app/docs)
- [Feedback & Feature Requests Board](https://www.lunasea.app/feedback)
- [Frequently Asked Questions](https://docs.lunasea.app/getting-started/frequently-asked-questions)
@@ -38,13 +41,11 @@ LunaSea even comes with support for multiple instances of applications using pro
[![Discord](https://img.shields.io/discord/673591529834807358?label=Discord&style=flat)](https://www.lunasea.app/discord)
[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/LunaSeaApp?label=r%2FLunaSeaApp&style=flat)](https://www.lunasea.app/reddit)
[![Hellonext](https://img.shields.io/badge/Feedback%20Board-Hellonext-red?style=flat&logo=redux&color=%234ECCA3&logoColor=white)](https://www.lunasea.app/feedback)
**Please only post bugs and issues to GitHub**. Use the [feedback & feature requests board](https://www.lunasea.app/feedback) for requests and general feedback.
**Please only create an issue on GitHub for bugs and software issues**. Post in the [discussions board](https://github.com/JagandeepBrar/LunaSea/discussions) or the [feedback & feature requests board](https://www.lunasea.app/feedback) for requests and general feedback.
- [Discord](https://www.lunasea.app/discord)
- [Email](mailto:hello@lunasea.app)
- [GitHub (Issues & Bug Reports Only)](https://github.com/JagandeepBrar/LunaSea/issues)
- [Reddit](https://www.lunasea.app/reddit)
- [Website](https://www.lunasea.app)