From fb23eb11d05919b147b44662108246032f9e0be5 Mon Sep 17 00:00:00 2001
From: AnthonyAxenov <anthonyaxenov@gmail.com>
Date: Sun, 6 Feb 2022 10:04:29 +0800
Subject: [PATCH] actual readme (api)

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.md b/README.md
index f9526ff..4bdb71b 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,35 @@ iptv.axenov.dev?ID
 
 Либо провернуть всё то же самое через браузер.
 
+## API
+
+Можно получать состояние плейлистов из этого сборника при помощи метода:
+
+```
+GET https://iptv.axenov.dev/getinfo=<ID>
+```
+
+где `ID` - один из идентификаторов, указанных в `playlists.ini` в квадратных скобках.
+
+Ответом может быть JSON следующего содержания:
+
+```json
+{
+    "is_online": true,
+    "count": 123,
+    "channels": [ ... ]
+}
+```
+
+где:
+* `is_online` - `bool`, доступность плейлиста
+* `count` - `uint|char[1]`, количество каналов >=0 либо `'-'` при `is_online === false`
+* `channels` - `string[]`, массив строк с названиями каналов, может быть пустым.
+
+Также ответ может быть пустым (вообще пустым, даже не `null`).
+Такое я встречал с одним конкретном плейлисте с поехавшей кодировкой.
+Лень разбираться, пофиг.
+
 ## Формат `playlists.ini`
 
 ```ini