Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iantrich authored Apr 22, 2020
1 parent 5d3dbd4 commit 21ea547
Showing 1 changed file with 11 additions and 21 deletions.
32 changes: 11 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,20 @@ Trakt's upcoming shows for [Home Assistant](https://www.home-assistant.io/)
## Installation:

1. Install this component by copying to your `/custom_components/trakt/` folder.
2. Install the card: [Upcoming Media Card](https://github.com/custom-cards/upcoming-media-card)
3. Add the code to your `configuration.yaml` using the config options below.
4. Add the code for the card to your `ui-lovelace.yaml`.
5. **You will need to restart after installation for the component to start working.**
2. Add the code to your `configuration.yaml` using the config options below.
3. Restart
4. Add the Integration from the UI and setup your options

* If you're having issues, check out the [troubleshooting guide](https://github.com/custom-cards/upcoming-media-card/blob/master/troubleshooting.md) before posting an issue or asking for help on the forums.
Note: The redirect_uri will be as follows:
* With HA cloud configured: https://<cloud-remote-url>/auth/external/callback
* Without HA cloud configured: http://<local-ip>:<port>/auth/external/callback or if base_url is used in HA -> https://<base-url>:<port>/auth/external/callback

**Example configuration.yaml:**

```yaml
sensor:
platform: trakt
id: 'sakdfjawioehrw3985728935uksdf'
secret: 'sdfoiwahjeflkaswjefi83q7829045uoijksldf'
username: iantrich
days: 10
exclude:
'The Bachelor'
trakt:
client_id: <client_id>
client_secret: <client_secret>
```
### Example ui-lovelace.yaml:
Expand All @@ -48,14 +44,8 @@ title: Upcoming Movies
key | type | description
:--- | :--- | :---
**platform (Required)** | string | `trakt`
**id (Required)** | string | Client ID (create new app at https://trakt.tv/oauth/applications - use device auth in redirect and uri urn:ietf:wg:oauth:2.0:oob)
**secret (Required)** | string | Client Secret (create new app at https://trakt.tv/oauth/applications - use device auth in redirect)
**username (Required)** | string | trakt.tv username
**days (Optional)** | number | How many days to look forward for movies/shows. Default `30`
**name (Optional)** | string | Sensor name. Default `Trakt Upcoming Calendar`
**exclude (Optional)** | array | List of show titles to exclude as Trakt does not allow removal of shows from its service

**client_id (Required)** | string | Client ID (create new app at https://trakt.tv/oauth/applications - use device auth in redirect and uri urn:ietf:wg:oauth:2.0:oob)
**client_secret (Required)** | string | Client Secret (create new app at https://trakt.tv/oauth/applications - use device auth in redirect)
***
Due to how `custom_components` are loaded, it is normal to see a `ModuleNotFoundError` error on first boot after adding this, to resolve it, restart Home-Assistant.
Expand Down

0 comments on commit 21ea547

Please sign in to comment.