]> git.giorgioravera.it Git - mercedes_me_api.git/commitdiff
Minor changes in README.md and alagned info.md with latest modifications
authorGiorgio Ravera <giorgio.ravera@gmail.com>
Sat, 19 Dec 2020 14:01:07 +0000 (15:01 +0100)
committerGiorgio Ravera <giorgio.ravera@gmail.com>
Sat, 19 Dec 2020 14:01:07 +0000 (15:01 +0100)
README.md
info.md

index f5bb84152bfac3c3536f5713c84a214876577b0f..bf648c72415083fbc3c125bfc0f9b4bb3fb05103 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,21 +5,21 @@
 [![License Status][license-img]][license-url]
 [![BuyMeCoffee][buymecoffee-img]][buymecoffee-url]
 
-Script to use Mercedes Me APIs.
+This repository contains a collection of scripts (including the Home Assistant Custom Component) in order to collect data from 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 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.
 
 ## Home Assistant Custom Component
-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).
+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).
 This component is still in development.
 ### Open Points
 - Complete OAUTH2 Authentication & Get the First Token
@@ -42,7 +42,7 @@ mercedesmeapi:
   vehicle_id: <**INSERT_YOUR_VEHICLE_ID**>
   scan_interval: <** TIME PERIOD (NUMBER OF SECONDS) 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)
 
 ## Shell Scripts
 There are two shell script:
diff --git a/info.md b/info.md
index da8677dae00929ae47970193cd877d79cb5714da..66b84c2e2effad4a6bd7bf8b2b714c7a555d24a6 100644 (file)
--- a/info.md
+++ b/info.md
@@ -1,14 +1,15 @@
 # mercedes_me_api 
-[![License Status][license-img]][license-url]
 [![Releases][releases-img]][releases-url]
 [![Last Commit][last-commit-img]][last-commit-url]
 [![hacs][hacs-img]][hacs-url]
+[![License Status][license-img]][license-url]
 [![BuyMeCoffee][buymecoffee-img]][buymecoffee-url]
 
 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).
+This component is still in development.
 
 ## Pre-Requirements
-1) Own a Mercedes-Benz Car with Mercedes me connect installed and working.
+1) Own a Mercedes Benz Car with Mercedes me 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)
@@ -39,7 +40,7 @@ mercedesmeapi:
   client_id: <**INSERT_YOUR_CLIENT_ID**>
   client_secret: <**INSERT_YOUR_CLIENT_SECRET**>
   vehicle_id: <**INSERT_YOUR_VEHICLE_ID**>
-  scan_interval: <** TIME PERIOD TO REFRESH RESOURCES **>
+  scan_interval: <** TIME PERIOD (NUMBER OF SECONDS) TO REFRESH RESOURCES **>
 ```
 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)