From 0677df2c330d535aec9b66758b1f24726fc68f31 Mon Sep 17 00:00:00 2001 From: Arhey Date: Tue, 7 Mar 2023 17:49:43 +0300 Subject: [PATCH] Create README.md --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..16a282f0b --- /dev/null +++ b/README.md @@ -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 + + + +### Contributors + + + +## License + +[![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](LICENSE)