Skip to content

Commit 67cbdd3

Browse files
committed
Include api docs in readme
1 parent 3b923ac commit 67cbdd3

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,11 @@
2121

2222
Currently the app is not available in the public Play Store. This is due to strict requirements by Google what kind of apps are allowed to be installed on cars. As of now the App is only available via internal test tracks which are limited to 100 users each. Currently there are no free internal test slots in any of the existing forks.
2323

24-
Once the app has reached a more finished state I will try to reach out to Polestar directly to potentially make it available through them. Just like ABRP or the Vivaldi browser which also do not comply with Google's restrictions.
24+
There are currently ongoing talks with Polestar to bring the app to a broader audience. But this will take some time and Polestar will most likely require some changes to make the app comply with there safety and usability standards.
2525

26+
## Using the webhook API
27+
28+
The app comes with the possibility to send data to a REST API endpoint. Details on this can be found in the [API documentation](/docs/APIDOC.md).
2629

2730
## Support the development of the app
2831

docs/APIDOC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For example:
2222

2323
## API versions
2424

25-
### 2.1
25+
### 2.1 (App version 0.25.2 and above)
2626

2727
API version 2.1 extends version 2.0 (see below) by some more optional values. These aim to be more complete than just plain real time values. The data is identical to the data saved to the local database of Car Stats Viewer. To receive these new values they have to be enabled in the Car Stats Viewer API settings:
2828

@@ -104,7 +104,7 @@ This key represents a charging session. It contains all necessary data to constr
104104

105105
Both of these new keys are optional. Depending on the app settings they are not contained in every request and the endpoint should not expect them to always exist. Also these keys are arrays and may contain more than just one set of data.
106106

107-
### 2.0
107+
### 2.0 (App version 0.25.0 and above)
108108

109109
The API version 2.0 sends the following data:
110110

0 commit comments

Comments
 (0)