readme

README.md

@@ -1,7 +1,83 @@
 # Sora
 
-**Still in early builds**
+<div align="center"> 
 
-Sora is a module based web scraping app. The porpouse of Sora is to scrape streams from sites added via modules. I Firstly made this app just for fun but mainly to get streams from my school site.
+<img src="https://raw.githubusercontent.com/cranci1/Ryu/main/Ryu/Assets.xcassets/AppIcon.appiconset/1024.jpg" width="240px">
 
-Also please don't use Sora for piracy. I do not promote piracy so please don't use Sora for such activites!
+[![Build and Release IPA](https://github.com/cranci1/Sora/actions/workflows/build.yml/badge.svg)](https://github.com/cranci1/Sora/actions/workflows/build.yml) [![Platform](https://img.shields.io/badge/Platform-iOS%20%7C%20iPadOS%2015.0%2B-orange?logo=apple&logoColor=white)](https://img.shields.io/badge/Platform-iOS%20%7C%20iPadOS%2014.0%2B-red?logo=apple&logoColor=white) [![Discord](https://img.shields.io/discord/1293430817841741899.svg?logo=discord&color=blue)](https://discord.gg/XR3SrmUbpd)
+
+A modular web scraping app, **Still in early builds** under the GPLv3.0 License
+
+</div>
+
+## Table of Contents
+
+- [Features](#features)
+- [Frequently Asked Questions](#frequently-asked-questions)
+- [Acknowledgements](#acknowledgements)
+- [License](#license)
+- [Legal](#legal)
+
+## Features
+
+- [x] iOS/iPadOS 15+ support
+- [x] JSON module support
+- [ ] JavaScript module support
+- [ ] macOS support
+
+## Frequently Asked Questions
+
+1. **What is Sora?**
+   - Sora is a module based web scraping app, made to work with modules only
+
+2. **Is Sora safe?**
+   - Yes, Sora is open-source and does not store user data on external servers.
+
+3. **Will Sora ever be paid?**
+   - No, Sora will always remain free without subscriptions, paid content, or any type of login.
+
+4. **How can i get module?**
+   - I do not provide any module for the app. Search for them on google or i dont know. I only create 1 module that is to watch videos of my school.
+
+## Acknowledgements
+
+FrameWorks:
+- [SwiftSoup](https://github.com/scinfu/SwiftSoup) - MIT License
+- [KingFisher](https://github.com/onevcat/Kingfisher) - MIT License
+
+## License
+
+This project is licensed under the [GNU General Public License v3.0](LICENSE).
+
+```
+Copyright © 2024 cranci. All rights reserved.
+
+Sora is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Sora is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Sora. If not, see <https://www.gnu.org/licenses/>.
+```
+
+## Legal
+
+**__Also, Sora is not made for Piracy! I don't promote piracy at all!__**
+
+### No Liability
+
+The developer(s) of this software assumes no liability for damages, legal claims, or other issues arising from the use or misuse of this software or any third-party modules. Users bear full responsibility for their actions. Use this software and modules at your own risk.
+
+### Third-Party Websites and Intellectual Property
+
+This software is not affiliated with or endorsed by any third-party websites. Any references to third-party sites in user-generated modules do not imply endorsement. Users are responsible for verifying that their scraping activities comply with the terms of service and intellectual property rights of the sites they interact with.
+
+### DMCA
+
+The developer(s) is not responsible for the misuse of any content inside or outside the app and shall not be responsible for the dissemination of any content within the app. Any violations should be send to the source website or module creator. The developer is not legally responsible for any module used inside the app.