diff --git a/README.md b/README.md index be35b1042c..a6e733608d 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ * [Docker](#docker-1) * [Virtual environment](#virtual-environment) * [Manual installation](#manual-installation-1) -- [Post-installation](#post-installation) +- [Configuration](#configuration) * [Configuration file](#configuration-file) + [Scripts directory](#scripts-directory) + [Splitting configuration on multiple files](#splitting-configuration-on-multiple-files) @@ -997,7 +997,7 @@ If you want to customize your installation, or if you need to install dependencies for a plugin that requires some manual steps, you can check out any plugin-specific installation steps from its documentation. -## Post-installation +## Configuration ### Configuration file @@ -1197,8 +1197,7 @@ Several integrations add their own feature-rich panels to the Web view, turning Platypush into a gateway to all of your services - from Zigbee sensors, to media players and services, to your music cloud, and more. -![Screenshot of the media panel, showing search results from multiple sources -and several supported types of streaming services](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/media-panel-screenshot-1.png) +For example, the music view is available to most of the `music` plugins. ![Screenshot of one of the music panels](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/music-panel-screenshot-1.png) @@ -1207,6 +1206,22 @@ panels](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/music-panel-scr streams across multiple devices](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/snapcast-panel-screenshot-1.png) +Another example is the camera panel, to monitor your cameras, get stand-alone +feed URLs, and take photos. This becomes available in the UI if you enable at +least a `camera` plugin. + +![Camera panel screenshot +1](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/Camera-panel-screenshot-1.png) + +If you enabled at least one local `media` plugin (like `media.vlc`, +`media.mplayer` etc.) then you'll also unlock the media UI, which allows you to +index, search, view and cast media files under the configured `media_dirs`, and +it also integrates with other configured/supported backends such as YouTube, +Plex and Jellyfin. + +![Media panel screenshot +1](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/Media-panel-screenshot-1.png) + ### Dashboards The web service also provides means for the user to create [custom diff --git a/docs/source/_static/styles/custom.css b/docs/source/_static/styles/custom.css index 03056de327..bcdc7c12f8 100644 --- a/docs/source/_static/styles/custom.css +++ b/docs/source/_static/styles/custom.css @@ -66,7 +66,8 @@ ul.grid li a { margin-top: 0.5em; } -ul.grid li:hover a { +ul.grid li:hover a, +ul.grid li:hover a > code { color: white !important; } diff --git a/docs/source/index.rst b/docs/source/index.rst index 30f983d6c5..8f6672ce29 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -24,9 +24,8 @@ Useful links ============ * The `main page `_ of the project. -* The `Gitea page `_. -* The `blog `_, for articles showing how to use - Platypush in real-world scenarios. +* The `source code `_. +* The `blog `_. Wiki ==== @@ -35,10 +34,14 @@ Wiki :maxdepth: 3 wiki/index + wiki/Quickstart wiki/Installation + wiki/Plugins-installation + wiki/APIs + wiki/Variables + wiki/Entities wiki/Configuration - wiki/Installing-extensions - wiki/A-configuration-example + wiki/A-full-configuration-example wiki/The-Web-interface Reference