[README] Updated README (#187)

* [README] Updated Header * [README] Added build/install instructions * [README] Added summary
2026-08-31 04:32:32 +00:00 · 2020-04-06 02:40:59 -05:00
parent f6f6a996f5
commit bc2f91d8ee
1 changed files with 64 additions and 15 deletions
--- a/README.md
+++ b/README.md
@@ -1,15 +1,64 @@
-<h1 align=center>LunaSea</h1>
-<p align=center>
-    <i>Flutter-based Usenet Manager for iOS</i>
-    <br>
-    <b>Under constant development</b>
-    <br>
-    <span>
-        <a href="https://github.com/JagandeepBrar/LunaSea/wiki/Build-Guide" target="_blank" rel="noopener noreferrer">Build Guide</a>
-        &ensp;|&ensp;
-        <a href="https://apps.apple.com/us/app/lunasea/id1496797802" target="_blank" rel="noopener noreferrer">App Store</a>
-        &ensp;|&ensp;
-        <a href="https://testflight.apple.com/join/WWXaybra" target="_blank" rel="noopener noreferrer">TestFlight</a>
-    </span>
-    <img src=https://i.imgur.com/yPhYyLY.png>
-</p>
+# LunaSea &ndash; Usenet Manager for iOS
+
+[![Homepage](https://img.shields.io/badge/Homepage-LunaSea-red?style=for-the-badge&logo=html5&color=%234ECCA3&logoColor=white)](https://www.lunasea.app) &nbsp; [![Release](https://img.shields.io/badge/AppStore-v2.0.0%20(333)-red?style=for-the-badge&logo=app-store&color=%230D96F6&logoColor=white)](https://apps.apple.com/us/app/lunasea/id1496797802?ls=1) &nbsp; [![License](https://img.shields.io/github/license/LunaSeaApp/LunaSea?color=%23222222&style=for-the-badge&logo=github&logoColor=white)](https://github.com/LunaSeaApp/LunaSea/blob/master/LICENSE)
+
+
+![Screenshot](https://www.lunasea.app/images/hero.png)
+
+LunaSea is a fully-featured, open-source usenet manager built using the Flutter framework for iOS! LunaSea is focused on giving you a seamless experience between all of your usenet software.
+
+Support for services include:
+- Lidarr
+- Radarr
+- Sonarr
+- SABnzbd
+- NZBGet
+- Newznab Indexer Searching
+- ...and more coming soon!
+
+LunaSea also comes with support for:
+- Profiles for multiple instances of applications
+- Backup and restore configuration from the filesystem
+
+---
+
+## Developing, Installing, &amp; Building
+
+#### Requirements
+
+1. A MacOS Machine
+2. An AppleID account (does not require developer account)
+3. [Flutter Framework (Beta Channel)](https://flutter.dev/)
+4. [XCode 11.4 or Higher](https://apps.apple.com/ca/app/xcode/id497799835?mt=12)
+5. [Developer Certificate Configured](https://github.com/LunaSeaApp/LunaSea/wiki/Setup-of-Development-Certificate)
+
+#### Developing
+
+1. Clone the repository
+    - `git clone git@github.com:LunaSeaApp/LunaSea.git`
+2. Install the Flutter packages
+    - `flutter pub get`
+3. Start your simulator or plug in your device and ensure you have accepted it is a trusted device
+4. Install LunaSea in development mode on your device or simulator
+    - `flutter run` 
+
+#### Installing
+
+> Release builds can only be installed on physical devices
+
+1. Clone the repository
+    - `git clone git@github.com:LunaSeaApp/LunaSea.git`
+2. Install the Flutter packages
+    - `flutter pub get`
+3. Plug in your device and ensure you have accepted it is a trusted device
+4. Install a production version of the application on your device
+    - `flutter run --release`
+
+#### Building (.ipa)
+
+1. Clone the repository
+    - `git clone git@github.com:LunaSeaApp/LunaSea.git`
+2. Install the Flutter packages
+    - `flutter pub get`
+3. Run `build_ipa` inside of the `scripts` folder
+4. The IPA will be placed in the root of the project directory