mirror of
https://github.com/iptv-org/iptv-org.github.io.git
synced 2025-05-11 17:40:05 -04:00
Create README.md
This commit is contained in:
parent
6161406426
commit
0677df2c33
1 changed files with 62 additions and 0 deletions
62
README.md
Normal file
62
README.md
Normal file
|
@ -0,0 +1,62 @@
|
|||
# iptv-org.github.io
|
||||
|
||||
## Developing
|
||||
|
||||
```sh
|
||||
# install dependencies
|
||||
npm install
|
||||
# run the development server
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## Building
|
||||
|
||||
```sh
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Deploying
|
||||
|
||||
The site is automatically deployed when commits land in `main` branch, via [GitHub Pages](https://pages.github.com/).
|
||||
|
||||
## Database
|
||||
|
||||
All channel data is taken from the [iptv-org/database](https://github.com/iptv-org/database) repository. If you find any errors please open a new [issue](https://github.com/iptv-org/database/issues) there.
|
||||
|
||||
## Streams
|
||||
|
||||
All links to the streams used on the site are taken from the [iptv-org/iptv](https://github.com/iptv-org/iptv) repository.
|
||||
|
||||
## EPG
|
||||
|
||||
All links to the guides used on the site are taken from the [iptv-org/epg](https://github.com/iptv-org/epg) repository.
|
||||
|
||||
## API
|
||||
|
||||
The API documentation can be found in the [iptv-org/api](https://github.com/iptv-org/api) repository.
|
||||
|
||||
## Resources
|
||||
|
||||
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
|
||||
|
||||
If you find a bug or want to contribute to the code or documentation, you can help by submitting an [issue](https://github.com/iptv-org/iptv-org.github.io/issues) or a [pull request](https://github.com/iptv-org/iptv-org.github.io/pulls).
|
||||
|
||||
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>
|
||||
|
||||
## License
|
||||
|
||||
[](LICENSE)
|
Loading…
Add table
Add a link
Reference in a new issue