]> git.giorgioravera.it Git - mercedes_me_api.git/commitdiff
Aligned info.md to the latest modification in README.md v0.4
authorGiorgio Ravera <giorgio.ravera@gmail.com>
Wed, 11 Nov 2020 13:15:11 +0000 (14:15 +0100)
committerGiorgio Ravera <giorgio.ravera@gmail.com>
Wed, 11 Nov 2020 13:15:11 +0000 (14:15 +0100)
info.md

diff --git a/info.md b/info.md
index ce24df9c5849841890f7ba2affe0ab5d6ae1aa30..da8677dae00929ae47970193cd877d79cb5714da 100644 (file)
--- a/info.md
+++ b/info.md
@@ -5,35 +5,34 @@
 [![hacs][hacs-img]][hacs-url]
 [![BuyMeCoffee][buymecoffee-img]][buymecoffee-url]
 
-Home Assistant Custom Component to integrate the sensors of a Mercedes-Benz car using [Mercedes Me APIs](https://developer.mercedes-benz.com/products).
+The Home Assistant Custom Component is a component to be added in Home Assistant in order to integrate the sensors of a Mercedes-Benz car using [Mercedes me API](https://developer.mercedes-benz.com/products).
 
 ## Pre-Requirements
-1) Own a Mercedes Benz Car with Mercedes Me installed and working.
+1) Own a Mercedes-Benz Car with Mercedes me connect installed and working.
 2) Create an application in https://developer.mercedes-benz.com/
 3) Register to the following APIs:
    - [Fuel Status](https://developer.mercedes-benz.com/products/fuel_status)
    - [Vehicle Lock Status](https://developer.mercedes-benz.com/products/vehicle_lock_status)
    - [Vehicle Status](https://developer.mercedes-benz.com/products/vehicle_status)
 
-Note: the APIs described above do not requires any subscription in case you use them with your own car associated the the Mercedes Me Account.
+Note: the APIs described above do not require any subscription in case you use them with your own car associated with the Mercedes me Account.
 Note2: only one car is supported for the moment.
 
-### Open Points
+## Open Points
 - Complete OAUTH2 Authentication & Get the First Token
 - Get state after starts -> now it waits <scan_interval> seconds.
 - Config Flow for automatic configuration
-- ~~HACS~~
 - Log Management
 - Bugfix & Software optimizations
 
 {% if not installed %}
-### Installation
+## Installation
 To use this custom component it's necessary to perform the following instructions:
 1) clone the repository
 2) create make a symbolic link from git_repost/custom_components/mercedesmeapi to hass_folder/custom_components
 
 {% endif %}
-### Configuration
+## Configuration
 1) Add in the configuration.yaml the following emelents:
 ```yaml
 mercedesmeapi:
@@ -42,7 +41,10 @@ mercedesmeapi:
   vehicle_id: <**INSERT_YOUR_VEHICLE_ID**>
   scan_interval: <** TIME PERIOD TO REFRESH RESOURCES **>
 ```
-2) Actually it's not possible to retrive the Token from scratch. Please use the other script to retrive the first token and copy it into hacs folder (.mercedesme_token)
+2) Actually it's not possible to retrieve the token from scratch. Please use the other script to retrieve the first token and copy it into hacs folder (.mercedesme_token)
+
+## Change Log
+You can find change log under [releases][releases-url]
 
 ## License
 [MIT](http://opensource.org/licenses/MIT) © Giorgio Ravera
@@ -62,4 +64,4 @@ mercedesmeapi:
 [hacs-url]: https://github.com/custom-components/hacs
 [buymecoffee-img]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg
 [buymecoffee-button]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
-[buymecoffee-url]: https://www.buymeacoffee.com/xraver
+[buymecoffee-url]: https://www.buymeacoffee.com/raverag