Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Bozydarek committed Dec 23, 2024
1 parent f291c38 commit 95d1aa9
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

This repository contains a python scripts that can check your energy usage statistics (based on unofficial API from eLicznik service) and show them in a form of a simple ASCII table.

**Disclaimer: Use at Your Own Risk. ⚠️**
> [!WARNING]
> Disclaimer: Use at Your Own Risk.
## Features

Expand All @@ -28,6 +29,9 @@ cd tauron_statistics
python3 -m pip -r requirements.txt
```

> [!TIP]
> You might want to use venv for installing dependencies.
Create configuration file:
```
cp config.example.yml config.yml
Expand All @@ -36,7 +40,8 @@ cp config.example.yml config.yml

## Configuration file

To use this script you need to create a configuration (`config.yml`) based on the example (`config.example.yml`).
> [!IMPORTANT]
> To use this script you need to create a configuration (`config.yml`) based on the example (`config.example.yml`).
Required values:
* `meter_id`
Expand Down

0 comments on commit 95d1aa9

Please # to comment.