Merge pull request #8372 from iptv-org/update-readme-template
Update README.md
This commit is contained in:
LaneSh4d0w
GitHub
commit
dd8a985183
|
|
@ -4,58 +4,114 @@
|
|||
|
||||
Collection of publicly available IPTV (Internet Protocol television) channels from all over the world.
|
||||
|
||||
## Usage
|
||||
## Table of contents
|
||||
|
||||
- 🚀 [How to use?](#how-to-use)
|
||||
- 📺 [Playlists](#playlists)
|
||||
- 🗓 [EPG](#epg)
|
||||
- 🗄 [Database](#database)
|
||||
- 👨💻 [API](#api)
|
||||
- 📚 [Resources](#resources)
|
||||
- 💬 [Discussions](#discussions)
|
||||
- 🛠 [Contribution](#contribution)
|
||||
- ⚖ [Legal](#legal)
|
||||
- © [License](#license)
|
||||
|
||||
## How to use?
|
||||
|
||||
Simply insert one of the links below into [any video player](https://github.com/iptv-org/awesome-iptv#apps) that supports live streaming and press _Open_.
|
||||
|
||||
|
||||
|
||||
To watch IPTV, simply insert one of the links below into any player that supports M3U playlists:
|
||||
## Playlists
|
||||
|
||||
- `https://iptv-org.github.io/iptv/index.m3u`
|
||||
- `https://iptv-org.github.io/iptv/index.nsfw.m3u` (includes adult channels)
|
||||
- `https://iptv-org.github.io/iptv/index.category.m3u` (grouped by category)
|
||||
- `https://iptv-org.github.io/iptv/index.country.m3u` (grouped by country)
|
||||
- `https://iptv-org.github.io/iptv/index.language.m3u` (grouped by language)
|
||||
- `https://iptv-org.github.io/iptv/index.region.m3u` (grouped by region)
|
||||
There are several versions of playlists that differ in the way they are grouped.
|
||||
|
||||
### Playlists by category
|
||||
### Main playlist
|
||||
|
||||
Playlist includes all known channels except adult channels.
|
||||
|
||||
```
|
||||
https://iptv-org.github.io/iptv/index.m3u
|
||||
```
|
||||
|
||||
And here is the full version:
|
||||
|
||||
```
|
||||
https://iptv-org.github.io/iptv/index.nsfw.m3u
|
||||
```
|
||||
|
||||
### Grouped by category
|
||||
|
||||
<details>
|
||||
<summary>Expand</summary>
|
||||
<br>
|
||||
|
||||
Playlist in which each channel has its _category_ as a group title:
|
||||
|
||||
```
|
||||
https://iptv-org.github.io/iptv/index.category.m3u
|
||||
```
|
||||
|
||||
Same thing, but split up into separate files:
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
#include "./.readme/_categories.md"
|
||||
|
||||
</details>
|
||||
|
||||
### Playlists by language
|
||||
### Grouped by language
|
||||
|
||||
<details>
|
||||
<summary>Expand</summary>
|
||||
<br>
|
||||
|
||||
Playlist in which each channel has its _language_ as a group title:
|
||||
|
||||
```
|
||||
https://iptv-org.github.io/iptv/index.language.m3u
|
||||
```
|
||||
|
||||
Same thing, but split up into separate files:
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
#include "./.readme/_languages.md"
|
||||
|
||||
</details>
|
||||
|
||||
### Playlists by country
|
||||
### Grouped by country
|
||||
|
||||
<details>
|
||||
<summary>Expand</summary>
|
||||
<br>
|
||||
|
||||
Playlist in which each channel has its _country_ as a group title:
|
||||
|
||||
```
|
||||
https://iptv-org.github.io/iptv/index.country.m3u
|
||||
```
|
||||
|
||||
Same thing, but split up into separate files:
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
#include "./.readme/_countries.md"
|
||||
|
||||
</details>
|
||||
|
||||
### Playlists by region
|
||||
### Grouped by region
|
||||
|
||||
<details>
|
||||
<summary>Expand</summary>
|
||||
<br>
|
||||
|
||||
Playlist in which each channel has its _region_ as a group title:
|
||||
|
||||
```
|
||||
https://iptv-org.github.io/iptv/index.region.m3u
|
||||
```
|
||||
|
||||
Same thing, but split up into separate files:
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
#include "./.readme/_regions.md"
|
||||
|
||||
|
|
@ -77,10 +133,24 @@ The API documentation can be found in the [iptv-org/api](https://github.com/iptv
|
|||
|
||||
Links to other useful IPTV-related resources can be found in the [iptv-org/awesome-iptv](https://github.com/iptv-org/awesome-iptv) repository.
|
||||
|
||||
## Discussions
|
||||
|
||||
If you have a question or an idea, you can post it in the [Discussions](https://github.com/iptv-org/iptv/discussions) tab.
|
||||
|
||||
## Contribution
|
||||
|
||||
Please make sure to read the [Contributing Guide](CONTRIBUTING.md) before sending an issue or making a pull request.
|
||||
|
||||
And thank you to everyone who has already contributed!
|
||||
|
||||
### Backers
|
||||
|
||||
<a href="https://opencollective.com/iptv-org"><img src="https://opencollective.com/iptv-org/backers.svg?width=890" /></a>
|
||||
|
||||
### Contributors
|
||||
|
||||
<a href="https://github.com/iptv-org/iptv/graphs/contributors"><img src="https://opencollective.com/iptv-org/contributors.svg?width=890" /></a>
|
||||
|
||||
## Legal
|
||||
|
||||
No video files are stored in this repository. The repository simply contains user-submitted links to publicly available video stream URLs, which to the best of our knowledge have been intentionally made publicly by the copyright holders. If any links in these playlists infringe on your rights as a copyright holder, they may be removed by sending a [pull request](https://github.com/iptv-org/iptv/pulls) or opening an [issue](https://github.com/iptv-org/iptv/issues/new?assignees=freearhey&labels=removal+request&template=--removal-request.yml&title=Remove%3A+). However, note that we have **no control** over the destination of the link, and just removing the link from the playlist will not remove its contents from the web. Note that linking does not directly infringe copyright because no copy is made on the site providing the link, and thus this is **not** a valid reason to send a DMCA notice to GitHub. To remove this content from the web, you should contact the web host that's actually hosting the content (**not** GitHub, nor the maintainers of this repository).
|
||||
|
|
|
|||
Loading…
Reference in New Issue