Skip to content

Commit

Permalink
docs: update README, add screenshot with epg
Browse files Browse the repository at this point in the history
  • Loading branch information
4gray committed Feb 7, 2021
1 parent e9ec2c3 commit e19890a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,31 @@
<img src="https://raw.githubusercontent.com/4gray/iptvnator/electron/src/assets/icons/favicon.256x256.png" alt="IPTVnator icon" title="Free IPTV player application" />
</p>
<p align="center">
<a href="https://github.com/4gray/iptvnator/releases"><img src="https://img.shields.io/github/release/4gray/iptvnator.svg?style=round-square" alt="Release"></a> <a href="https://github.com/4gray/iptvnator/actions"><img src="https://github.com/4gray/iptvnator/workflows/Build%20and%20release/badge.svg" alt="Build and release"></a> <a href="https://github.com/4gray/iptvnator/releases"><img src="https://img.shields.io/github/downloads/4gray/iptvnator/total" alt="Releases"></a> <a href="https://codecov.io/gh/4gray/iptvnator"><img src="https://codecov.io/gh/4gray/iptvnator/branch/electron/graph/badge.svg?token=J53BMPYOFP"/></a>
<a href="https://github.com/4gray/iptvnator/releases"><img src="https://img.shields.io/github/release/4gray/iptvnator.svg?style=for-the-badge&logo=appveyor" alt="Release"></a> <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/4gray/iptvnator/Build%20and%20release?style=for-the-badge"> <a href="https://github.com/4gray/iptvnator/releases"><img src="https://img.shields.io/github/downloads/4gray/iptvnator/total?style=for-the-badge&logo=appveyor" alt="Releases"></a> <img alt="Codecov" src="https://img.shields.io/codecov/c/github/4gray/iptvnator?style=for-the-badge">
</p>

**IPTVnator** is a video player application that provides support for the playback of IPTV playlists (m3u, m3u8). The application allows to import playlists by using remote URLs or per file upload from the file system. Additionally there is a support of EPG information XMLTV-based which can be provided by URL.

The application is an cross-platform and open source project based on Electron and Angular.

**Features:**
![Welcome screen: Playlists overview](./iptv-epg.png)

## Features

- M3u and M3u8 playlists support 📺
- Upload playlists from a file system 📂
- Upload remote playlists via URL 🔗
- Add remote playlists via URL 🔗
- Open playlist from the file system
- Search for channels 🔍
- EPG support
- EPG support (TV Guide)
- TV archive/catchup/timeshift
- Group-based channels list
- Open playlist from the file system
- Save channels as favorites
- HTML video player with hls.js support or Video.js based player


## Screenshots:

| Welcome screen: Playlists overview | Main player interface with channels sidebar and video player |
| :----------------------------------------------------------: | :-------------------------------------------------------: |
| ![Welcome screen: Playlists overview](./playlists.png) | ![Sidebar with channel and video player](./iptv-main.png) |
Expand All @@ -32,7 +37,7 @@ The application is an cross-platform and open source project based on Electron a

*Note: First version of the application which was developed as a PWA is available in an extra git branch.*

# Download
## Download

Download the latest version of the application for macOS, Windows and Linux from the [release page](https://github.com/4gray/iptvnator/releases).

Expand All @@ -43,3 +48,8 @@ $ sudo snap install iptvnator
```

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/iptvnator)


## Disclaimer

IPTVnator doesn't provide any playlists or other digital content.
Binary file added iptv-epg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e19890a

Please sign in to comment.