From 138e8a30273105bdcac0883378ce48d5439ca535 Mon Sep 17 00:00:00 2001 From: 4gray Date: Sun, 1 Dec 2024 13:51:57 +0100 Subject: [PATCH] chore: update readme file --- README.md | 51 +++++++++++++-------------------------------------- 1 file changed, 13 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 4b302648c..ba33f925d 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,16 @@ IPTVnator icon

- Release GitHub Workflow Status Releases Codecov Telegram + Release + + GitHub Workflow Status Releases Codecov Telegram Bluesky

Telegram channel for discussions **IPTVnator** is a video player application that provides support for IPTV playlist playback (m3u, m3u8). The application allows users to import playlists using remote URLs or by uploading files from the local file system. Additionally, it supports EPG information in XMLTV format which can be provided via URL. -The application is a cross-platform, open-source project built with Electron and Angular. +The application is a cross-platform, open-source project built with Electron (currently migrating to Tauri) and Angular. ⚠️ Note: IPTVnator does not provide any playlists or other digital content. The channels and pictures in the screenshots are for demonstration purposes only. @@ -83,52 +85,25 @@ sudo emerge iptvnator-bin Buy Me A Coffee -## How to Build +## How to Build and Develop -Requirements: Node.js with npm +Requirements: +* Node.js with npm +* Rust (required for tauri) 1. Clone this repository and install project dependencies: ``` $ npm install ``` -2. Build the application for your platform using one of the following commands: +2. Start the application: ``` - # Linux - $ npm run electron:build:linux + $ npm run tauri dev ``` - ``` - # macOS - $ npm run electron:build:mac - ``` +This will open the Tauri version in a separate window, while the PWA version will be available at http://localhost:4200. - ``` - # Windows - $ npm run electron:build:windows - ``` - -These commands will generate distributable assets in the `release` folder based on the electron-builder configuration stored in `electron-builder.json` and `package.json`. For custom configurations, please refer to the [electron-builder API documentation](https://www.electron.build/). - -*Note: Cross-platform building may not be supported. [Read more](https://www.electron.build/multi-platform-build)* - -## Development - -First, install all required dependencies: - - ``` - $ npm install - ``` - -To develop the application in both PWA and Electron modes, run: - - ``` - $ npm run start - ``` - -This will open the Electron version in a separate window, while the PWA version will be available at http://localhost:4200. - -To run only the Angular app without Electron, use: +To run only the Angular app without Tauri, use: ``` $ npm run serve @@ -136,7 +111,7 @@ To run only the Angular app without Electron, use: ## Disclaimer -IPTVnator doesn't provide any playlists or other digital content. +**IPTVnator doesn't provide any playlists or other digital content.** [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)