From 80a063779bae9ed2b8c3d9ca56558c0907881272 Mon Sep 17 00:00:00 2001 From: Aleksandr Statciuk Date: Fri, 3 Jun 2022 15:38:00 +0300 Subject: [PATCH] Update README.md --- README.md | 89 +++++-------------------------------------------------- 1 file changed, 8 insertions(+), 81 deletions(-) diff --git a/README.md b/README.md index 73d40c65..80cfa22d 100644 --- a/README.md +++ b/README.md @@ -1,88 +1,15 @@ # Database [![check](https://github.com/iptv-org/database/actions/workflows/check.yml/badge.svg)](https://github.com/iptv-org/database/actions/workflows/check.yml) -![channels.csv](https://github.com/iptv-org/database/raw/master/.readme/preview.png) +User editable database for TV channels. -All data is stored in the [/data](data) folder as [CSV](https://en.wikipedia.org/wiki/Comma-separated_values) (Comma-separated values) files. Any of the files can be edited either with a basic text editor or through any spreadsheet editor (such as [Google Sheets](https://www.google.com/sheets/about/), [LibreOffice](https://www.libreoffice.org/discover/libreoffice/), ...). +All data is stored in the [/data](data) folder as [CSV](https://en.wikipedia.org/wiki/Comma-separated_values) (Comma-separated values) files and can be edited with any spreadsheet editor (such as [Google Sheets](https://www.google.com/sheets/about/), [LibreOffice](https://www.libreoffice.org/discover/libreoffice/), ...). -## Data Scheme - -- [channels](#channels) -- [categories](#categories) -- [countries](#countries) -- [languages](#languages) -- [regions](#regions) -- [subdivisions](#subdivisions) -- [blocklist](#blocklist) - -### channels - -| Field | Description | Required | Example | -| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------ | -| id | Unique channel ID. Should be derived from the name of the channel and country code separated by dot. May only contain Latin letters, numbers and dot. | Required | `AnhuiTV.cn` | -| name | Official channel name in English. May include: `a-z`, `à-ÿ`, `0-9`, `space`, `-`, `!`, `:`, `&`, `.`, `+`, `'`, `/`, `»`, `#`, `%`, `°`, `$`, `@`, `?`, `(`, `)`. | Required | `Anhui TV` | -| native_name | Channel name in the original language. Used when different from `name`. May contain any characters except `,` and `"`. | Optional | `安徽卫视` | -| network | Network of which this channel is a part. | Optional | `Anhui` | -| country | Country code from which the channel is transmitted. A list of all supported countries and their codes can be found in [data/countries.csv](data/countries.csv) | Required | `CN` | -| subdivision | Code of the subdivision (e.g., provinces or states) from which the broadcast is transmitted. A list of all supported subdivisions and their codes can be found in [data/subdivisions.csv](data/subdivisions.csv) | Optional | `CN-AH` | -| city | Name of the city from which the channel is transmitted. May only contain `a-z`, `à-ÿ`, `0-9`, `space`, `-`, `'`. | Optional | `Hefei` | -| broadcast_area | List of codes describing the broadcasting area of the channel. Any combination of `r/`, `c/`, `s/` | Required | `s/CN-AH` | -| languages | List of languages in which the channel is broadcast separated by `;`. A list of all supported languages and their codes can be found in [data/languages.csv](data/languages.csv) | Required | `zho` | -| categories | List of categories to which this channel belongs separated by `;`. A list of all supported categories can be found in [data/categories.csv](data/categories.csv) | Optional | `general` | -| is_nsfw | Indicates whether the channel broadcasts adult content (`TRUE` or `FALSE`) | Required | `FALSE` | -| launched | Launch date of the channel (`YYYY-MM-DD`) | Optional | `2016-07-28` | -| closed | Date on which the channel closed (`YYYY-MM-DD`) | Optional | `2020-05-31` | -| replaced_by | The ID of the channel that this channel was replaced by. | Optional | `CCTV1.cn` | -| website | Official website URL. | Optional | `http://www.ahtv.cn/` | -| logo | Logo URL. Only URL with HTTPS protocol are allowed. Supported image types: `PNG`, `JPEG`. | Required | `https://example.com/logo.png` | - -### categories - -| Field | Description | Required | Example | -| ----- | -------------- | -------- | ------- | -| id | Category ID. | Required | `news` | -| name | Category name. | Required | `News` | - -### languages - -| Field | Description | Required | Example | -| ----- | ------------------------------------------------------------------------- | -------- | ---------- | -| name | Official language name | Required | `Croatian` | -| code | [ISO 639-3](https://en.wikipedia.org/wiki/ISO_639-3) code of the language | Required | `hrv` | - -### countries - -| Field | Description | Required | Example | -| ----- | ------------------------------------------------------------------------------------------ | -------- | ------------ | -| name | Official name of the country | Required | `Martinique` | -| code | [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country | Required | `MQ` | -| lang | Official language in the country. | Required | `fra` | -| flag | Country flag emoji | Required | `🇲🇶` | - -### subdivisions - -| Field | Description | Required | Example | -| ------- | ------------------------------------------------------------------------------ | -------- | ------------------ | -| country | Country code of the division. | Required | `CA` | -| name | Official subdivision name | Required | `British Columbia` | -| code | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code of the subdivision | Required | `CA-BC` | - -### regions - -| Field | Description | Required | Example | -| --------- | ---------------------------------------------------------------------------------------------------------------------- | -------- | ---------------- | -| name | Official name of the region. | Required | `Central Asia` | -| code | Abbreviated designation for the region. May only contain Latin letters in upper case. The minimum length is 3 letters. | Required | `CAS` | -| countries | List of country codes in the region. | Required | `KG;KZ;TJ;TM;UZ` | - -### blocklist - -List of channels blocked at the request of copyright holders. - -| Field | Description | Required | Example | -| ------- | ----------------------------------------------- | -------- | --------------------------------- | -| channel | Channel ID | Required | `AnimalPlanetAfrica.us` | -| ref | Link to removal request or DMCA takedown notice | Required | `https://example.com/issues/0000` | +![channels.csv](.readme/preview.png) ## 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/database/issues) or a [pull request](https://github.com/iptv-org/database/pulls). +Please make sure to read the [Contributing Guide](CONTRIBUTING.md) before sending an issue or making a pull request. + +## License + +[![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](LICENSE)