diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..1ef8b27 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Siddharth Kamble + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 8d1c8b6..9d8e691 100644 --- a/README.md +++ b/README.md @@ -1 +1,70 @@ - +# Sparkle-TV2 ✨📺 + +This Android app serves as an opener for the IPTV player installed by the user after running Termux. + +## Overview 🌐 + +The app is designed to check if a server is running successfully on Termux at `localhost:5001`. If the server is running, the app opens the user's installed IPTV player. + +## Features 🚀 + +- ✔️ Checks for the running server on Termux. +- ▶️ Opens the installed IPTV player if the server is running. +- 🚀 Simplifies the process of launching the IPTV player after setting up the server on Termux. +- ▶️ If the server is already running, it just opens the configured IPTV player. + + +## How to Use 📲 + +1. Ensure you have [Termux](https://github.com/termux/termux-app) installed and Done [JioTV](https://jiotv_go.rabil.me/get_started) server setup. +2. Configure Termux autostart via `bash.bashrc`: + - Open Termux. + - Edit `bash.bashrc` using a text editor like nano: + + ```bash + nano $PREFIX/etc/bash.bashrc + ``` + - Add the lines at end of file. + + ```bash + termux-wake-lock + $HOME/.jiotv_go/bin/jiotv_go run -P + ``` + - Save and exit. + +3. Select the installed IPTV player app on your device. + +4. Run the app. + +5. If the server is running successfully, the app will open the installed IPTV player. + +6. If you want to choose another app, clear the app data to reset. + + +> [!NOTE] +> Server running at "localhost:5001" are supported. + +## Download ⬇️ + +[](https://github.com/siddharthsky/SparkleTV2-auto-service/releases) + + +## Dependencies 🛠️ + +- Termux (for running the server) +- Server configured with autostart [any one] + - JioTV GO server by [rabilrbl](https://github.com/rabilrbl/jiotv_go) ([recommended](https://rabilrbl.github.io/jiotv_go/Usage-Guide/#android-users-weve-got-you-covered)) + - J-TV self server NPM by [dhruv-2015](https://github.com/dhruv-2015/JIOTVServer) + + +## Acknowledgements 🙌 + +- [Termux](https://github.com/termux) +- [rabilrbl](https://github.com/rabilrbl) +- [dhruv-2015](https://github.com/dhruv-2015) +