Skip to content

Commit 394732a

Browse files
committed
Added readme
1 parent f8195ec commit 394732a

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
1-
# elaway-charge-api
1+
# Elaway Gateway API
2+
3+
Elaway Charge API is a Node.js application that interacts with the Elaway charging infrastructure. It provides an interface to manage and monitor electric vehicle (EV) charging points using the Elaway API.
4+
5+
## Features
6+
7+
- Authenticate with the Elaway API using OAuth2.
8+
- Retrieve and manage charging point data.
9+
- Start and stop charging sessions.
10+
- TODO: Automatically refresh access tokens to maintain session validity.
11+
12+
## Prerequisites
13+
14+
- Node.js
15+
- Docker (optional, for containerized deployment)
16+
17+
## Installation
18+
19+
The recommended way would be to use docker. Copy the docker-compose.yml.example and fill in your information.
20+
21+
For legal reasons the client secrets are not provided here, but can be aquired with [mitmproxy](https://www.google.com/search?q=mitmporxy).

0 commit comments

Comments
 (0)