Skip to content

Add documentation for display_currency setting to CoinMarketCap sensor #3779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 26, 2017
Merged

Add documentation for display_currency setting to CoinMarketCap sensor #3779

merged 2 commits into from
Oct 26, 2017

Conversation

NextNebula
Copy link
Contributor

Description:
Add documentation for the new display_currency setting that has been added to the CoinMarketCap sensor.

Pull request in home-assistant (if applicable): home-assistant/core#10093


To add the CoinMarketCap sensor to your installation, add the following lines to your `configuration.yaml`:

```yaml
# Example configuration.yaml entry
sensor:
- platform: coinmarketcap
currency: ethereum
display_currency: EUR
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We try to keep all configuration samples minimal. Thus, no optional requirement in the default sample. This helps user to get started quickly by copy-&-paste the sample without worrying about optional parameters which they most likely not need. If required, insert a full configuration sample later that covers special setups or alike.

@fabaff fabaff added Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! new-feature This PR adds documentation for a new Home Assistant feature to an existing integration labels Oct 26, 2017
Copy link
Member

@fabaff fabaff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 🐦

@fabaff fabaff merged commit 15c9617 into home-assistant:next Oct 26, 2017
@NextNebula NextNebula deleted the coinmarkercap branch October 26, 2017 16:51
fabaff pushed a commit that referenced this pull request Oct 31, 2017
#3779)

* Add documentation for display_currency setting to CoinMarketCap sensor.

* Make example configuration simple again
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! new-feature This PR adds documentation for a new Home Assistant feature to an existing integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants