README was updated.

This commit is contained in:
Alexander Andreev 2024-11-04 15:39:05 +04:00
parent 8e09177f24
commit 241ebf7fb4
Signed by: Arav
GPG Key ID: 25969B23DCB5CA34

View File

@ -8,12 +8,14 @@ Calculates cost of electricity.
$ kwh-cost [OPTIONS] price wattage interval [interval ..] $ kwh-cost [OPTIONS] price wattage interval [interval ..]
``` ```
Options are `-v, --version` to show program's version; and `-h, --help` to show usage of a program. Options are `-v` to show program's version; and `-h` to show usage of a program.
`price` is a price per kWh. `wattage` is how many Watts being consumed. `interval` is for how long. `price` is a price per kWh. `wattage` is how many Watts being consumed. `interval` is for how long.
`interval` is in seconds, but you can specify a unit. Units are the following: `wattage` is in Watts, but it can come with following units: `m`, `k|K`, `M`, `G`, `T`.
`m|M` for minutes; `h|H` for hours; and `d|D` for days. There could be as many `interval`s passed as you need.
`interval` is in seconds, but the following units are supported: `m|M` for minutes; `h|H` for hours;
and `d|D` for days. Also, there could be as many `interval`s passed as you need.
Here is an example: Here is an example: