Skip to content

Commit

Permalink
Merge pull request #25 from smlx/readme-alerts
Browse files Browse the repository at this point in the history
chore: fix alert syntax in README
  • Loading branch information
smlx authored Jan 19, 2024
2 parents 83c193c + 0a11e53 commit fd7bc94
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Currently hardware support in the SEMS MITM Exporter is limited to the equipment

PRs welcome if you want to add support for your device.

[!NOTE]
I don't have a battery, so the exporter and metrics naming reflects that.
Open issues to discuss how to improve this if you have a battery and don't like the metric naming.
> [!NOTE]
> I don't have a battery, so the exporter and metrics naming reflects that.
> Open issues to discuss how to improve this if you have a battery and don't like the metric naming.
### How to get it

Expand All @@ -52,11 +52,11 @@ Detailed instructions for supported hardware is a WIP.

## Metrics exported

[!NOTE]
Only the useful metrics are listed here. Unlisted metrics which are also exported include:

* Device metrics which aren't particularly useful (e.g. other values summed together).
* Values which are unknown due to uncertainties when reverse engineering the packet structure (`*_unknown_*` variables). If you figure out what these are, please open an issue/PR.
> [!NOTE]
> Only the useful metrics are listed here. Unlisted metrics which are also exported include:
>
> * Device metrics which aren't particularly useful (e.g. other values summed together).
> * Values which are unknown due to uncertainties when reverse engineering the packet structure (`*_unknown_*` variables). If you figure out what these are, please open an issue/PR.
Except where noted, all metrics are labelled with:

Expand Down

0 comments on commit fd7bc94

Please sign in to comment.