(readme): Updated README.md

This commit is contained in:
Jagandeep Brar
2021-03-24 08:43:15 -05:00
parent e380b6760c
commit 2c444d4729

86
README.md Normal file
View File

@@ -0,0 +1,86 @@
# <img width="40px" src="./assets/images/branding/icon_drawer.png" alt="LunaSea"></img>&nbsp;&nbsp;LunaSea
[![App Store](https://img.shields.io/badge/%20Download-ios-red?style=for-the-badge&logo=app-store&color=%232196F3&logoColor=white)](https://www.lunasea.app/appstore)
[![Play Store](https://img.shields.io/badge/%20Download-android-red?style=for-the-badge&logo=google-play&color=%234CAF50&logoColor=white)](https://www.lunasea.app/playstore)
[![License](https://img.shields.io/github/license/CometTools/LunaSea?style=for-the-badge)](https://github.com/CometTools/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, LunaSea supports:
- [Lidarr](https://github.com/lidarr/lidarr)
- [Radarr](https://github.com/radarr/radarr)
- [Sonarr](https://github.com/sonarr/sonarr)
- [NZBGet](https://github.com/nzbget/nzbget)
- [SABnzbd](https://github.com/sabnzbd/sabnzbd)
- [Newznab Indexer Searching](https://newznab.readthedocs.io/en/latest/misc/api/)
- [NZBHydra2](https://github.com/theotherp/nzbhydra2)
- [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!
> Please note that LunaSea is purely a remote control application, it does not offer any functionality without software installed on a server/computer.
## Getting Started
- [Releases](https://github.com/CometTools/LunaSea/releases)
- [(iOS) App Store](https://www.lunasea.app/appstore)
- [(Android) Play Store](https://www.lunasea.app/playstore)
- [Build Guide](https://github.com/CometTools/LunaSea/wiki/Build-Guide)
- [(iOS) Development Certificate Setup](https://github.com/CometTools/LunaSea/wiki/Setup-of-Development-Certificate)
- [(Android) Keystore Setup](https://github.com/CometTools/LunaSea/wiki/Configure-Keystore)
- [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)
## Support
[![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.
- [Discord](https://www.lunasea.app/discord)
- [Email](mailto:hello@comet.tools)
- [GitHub (Issues & Bug Reports Only)](https://github.com/CometTools/LunaSea/issues)
- [Reddit](https://www.lunasea.app/reddit)
- [Website](https://www.lunasea.app)
## Tools & Services
[![Translation status](https://hosted.weblate.org/widgets/lunasea/-/svg-badge.svg)](https://www.lunasea.app/translate)
Thank you to all tools and services for offering free subscriptions for open-source projects!
- [Gitbook](https://www.gitbook.com): Gitbook is used to host LunaSea's documentation
- [Hellonext](https://www.hellonext.co): Hellonext is used to host LunaSea's feedback, changelog, and roadmap
- [Weblate](https://weblate.org): Weblate is used to gather community localization for LunaSea
## Contributors
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
Thank you to everyone who has helped contribute to LunaSea, from development to localization efforts!
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://www.jagandeepbrar.io"><img src="https://avatars.githubusercontent.com/u/3048295?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jagandeep Brar</b></sub></a><br /><a href="https://github.com/CometTools/LunaSea/commits?author=JagandeepBrar" title="Code">💻</a> <a href="#design-JagandeepBrar" title="Design">🎨</a> <a href="#maintenance-JagandeepBrar" title="Maintenance">🚧</a> <a href="#ideas-JagandeepBrar" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/lightglitch"><img src="https://avatars.githubusercontent.com/u/196953?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mário Franco</b></sub></a><br /><a href="https://github.com/CometTools/LunaSea/commits?author=lightglitch" title="Code">💻</a></td>
<td align="center"><a href="https://pythonexplainedto.me/"><img src="https://avatars.githubusercontent.com/u/41962737?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Patrik Hauguth</b></sub></a><br /><a href="#translation-Phaugt" title="Translation">🌍</a></td>
<td align="center"><a href="https://liberapay.com/kingu/"><img src="https://avatars.githubusercontent.com/u/13802408?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Allan Nordhøy</b></sub></a><br /><a href="#translation-comradekingu" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/cpt-kuesel"><img src="https://avatars.githubusercontent.com/u/79487102?v=4?s=100" width="100px;" alt=""/><br /><sub><b>cpt-kuesel</b></sub></a><br /><a href="#translation-cpt-kuesel" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/KovalevArtem"><img src="https://avatars.githubusercontent.com/u/36500228?v=4?s=100" width="100px;" alt=""/><br /><sub><b>KovalevArtem</b></sub></a><br /><a href="#translation-KovalevArtem" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/iFelix18"><img src="https://avatars.githubusercontent.com/u/19800006?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Davide</b></sub></a><br /><a href="#translation-iFelix18" title="Translation">🌍</a></td>
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->