diff --git a/README.md b/README.md index 78d8a95..42933f4 100644 --- a/README.md +++ b/README.md @@ -227,6 +227,9 @@ Once submitted, `config.json` is created on the server. **The setup page becomes --- +
+Editing the config later + ### Editing the config later You can re-open the setup page at any time using the admin key generated during first setup: @@ -266,6 +269,11 @@ nano /var/www/gridtv/config.json --- +
+ +
+Project structure + ## πŸ“ Project structure ``` @@ -327,6 +335,11 @@ gridtv/ --- +
+ +
+Themes + ## 🎨 Themes GridTV ships with 4 built-in themes. To add your own, create a CSS file in `themes/` with these metadata comments at the top: @@ -347,6 +360,11 @@ Drop it in `themes/` β€” it appears in the theme selector automatically. --- +
+ +
+Multiple EPG Sources + ## πŸ“‘ Multiple EPG Sources Configure as many EPG/M3U sources as you want in `config.json`. A dropdown appears in the topbar when more than one source is defined. @@ -355,6 +373,11 @@ If `allow_personal_epg` is `true`, a **"✏ Personal EPG"** option appears in th --- +
+ +
+Built-in Player + ## ▢️ Built-in Player Click on any **channel name** or **currently airing program** to open a PiP player in the bottom-right corner. @@ -363,6 +386,11 @@ Requires an **M3U URL** in the active source and the **php-curl** extension. The --- +
+ +
+Advanced configuration + ## βš™οΈ Advanced configuration Tweak these constants in `src/js/config.js`: @@ -375,6 +403,11 @@ const ROW_H = 80; // Channel row height (px) --- +
+ +
+EPG Compatibility + ## 🧩 EPG Compatibility GridTV parses the standard **XMLTV format**. Tested with: @@ -387,6 +420,11 @@ GridTV parses the standard **XMLTV format**. Tested with: --- +
+ +
+Internationalization + ## 🌍 Internationalization GridTV auto-detects the visitor's browser language and serves the matching locale. Supported out of the box: **English**, **French**, **Spanish**. @@ -402,18 +440,33 @@ GridTV will automatically pick it up for browsers with that language set β€” no --- +
+ +
+Contributing + ## 🀝 Contributing PRs are welcome! Got an idea, a fix, or a feature request β€” open an issue or send a PR. --- +
+ +
+License + ## πŸ“„ License GNU Affero General Public License v3.0 (AGPLv3) --- +
+ +
+Roadmap + ## πŸ—ΊοΈ Roadmap ### βœ… Done @@ -437,3 +490,4 @@ GNU Affero General Public License v3.0 (AGPLv3) ### πŸ”œ Coming soon - **Dark/Light auto mode** β€” follow system preference when using the default theme - **Grid export** β€” export today's schedule as PDF or image +