diff --git a/source/_components/reddit.markdown b/source/_components/reddit.markdown index d9946b33037..ace5471d53a 100644 --- a/source/_components/reddit.markdown +++ b/source/_components/reddit.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Reddit Sensor" +title: "Reddit" description: "How to integrate the Reddit sensor into Home Assistant." date: 2018-02-21 20:00 sidebar: true @@ -19,7 +19,7 @@ The Reddit sensor integrates data from [Reddit](https://reddit.com/) to monitor ## {% linkable_title Setup %} -To set up this sensor, you will need to generate a `client_id` and `client_secret` for the user account you will use to connect. Follow the first steps in [this wiki](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example). +To set up this sensor, you will need to generate a `client_id` and `client_secret` for the user account you will use to connect. Follow the first steps in [this Wiki page](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example). ## {% linkable_title Configuration %} @@ -27,14 +27,15 @@ To enable this platform, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry -- platform: reddit - username: !secret reddit_username - password: !secret reddit_password - client_id: !secret reddit_client_id - client_secret: !secret reddit_client_secret - subreddits: - - news - - worldnews +sensor: + - platform: reddit + username: !secret reddit_username + password: !secret reddit_password + client_id: !secret reddit_client_id + client_secret: !secret reddit_client_secret + subreddits: + - news + - worldnews ``` {% configuration %} @@ -47,11 +48,11 @@ password: required: true type: string client_id: - description: Your Reddit account client_id generated from the wiki above. + description: Your Reddit account client ID. required: true type: string client_secret: - description: Your Reddit account client_secret generated from the wiki above. + description: Your Reddit account client secret required: true type: string subreddits: @@ -59,7 +60,7 @@ subreddits: required: true type: list sort_by: - description: Sort reddit posts by new, top, controversial, and hot. + description: "Sort reddit posts by `new`, `top`, `controversial` and `hot`." required: false type: string default: hot