Skip to content

Commit be4b388

Browse files
Fix cosmetics in documentation
Signed-off-by: Daniel Zullo <[email protected]>
1 parent fc7982a commit be4b388

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Electricity Trading API client for Python
1010
The Frequenz Electricity Trading API client for Python is an easy-to-use Python interface built to interact with the Frequenz Electricity Trading API. It allows you to create orders, get market data, and manage your orders.
1111

1212
## Features
13+
1314
* **Create and manage gridpool orders**: Place new orders, update existing ones, and cancel orders when necessary.
1415
* **Stream live data**: Get real-time updates on market data, including order books, trades, and market prices.
1516
* **Retrieve historical data**: Access historical data on market trades.
@@ -18,17 +19,17 @@ The Frequenz Electricity Trading API client for Python is an easy-to-use Python
1819

1920
The following platforms are officially supported (tested):
2021

21-
- **Python:** 3.11
22-
- **Operating System:** Ubuntu Linux 20.04
23-
- **Architectures:** amd64, arm64
22+
* **Python:** 3.11
23+
* **Operating System:** Ubuntu Linux 20.04
24+
* **Architectures:** amd64, arm64
2425

2526
## Usage
2627

2728
### Installation
2829

2930
You can install the Frequenz Electricity Trading API client via pip. Replace `VERSION` with the specific version you wish to install.
3031

31-
```
32+
```sh
3233
# Choose the version you want to install
3334
VERSION=0.2.2
3435
pip install frequenz-client-electricity-trading==$VERSION
@@ -37,6 +38,7 @@ pip install frequenz-client-electricity-trading==$VERSION
3738
### Initialization
3839

3940
First, initialize the client with the appropriate server URL and API key.
41+
4042
```python
4143
from frequenz.client.electricity_trading import Client
4244

@@ -52,6 +54,7 @@ client = Client(
5254
### Create an Order
5355

5456
Here's an example of how one can create a limit order to buy energy.
57+
5558
```python
5659
from frequenz.client.electricity_trading import (
5760
Currency,

0 commit comments

Comments
 (0)