From 936dcde75c42ef5fb563e808234f3f7e9338f2ba Mon Sep 17 00:00:00 2001 From: VG Date: Sun, 26 May 2024 17:52:53 +0300 Subject: [PATCH] updated readme --- readme.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 3ee5daa..9f8768b 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,15 @@ # Grafana exporter for ZTE 5G modems -Howto? To just run, either run with docker run or use the provided compose.yml for docker composing. +## Getting started + +One can just run the provided python script by `python3 zte_exporter ` + +A docker file is provided to compile this and example compose.yml to use in compose tools. To use with docker run, just create .env with the correct values. dockerhub vvkvvk/zte-exporter has the latest version of this available. + +## Tested devices Probably works with other ZTE models, only tested with ZTE MC7010. A simple Grafana dashboard included with the grafana.json. -Based on work by https://github.com/Kajkac/ZTE-MC-Home-assistant +## Thanks + +Largely based on https://github.com/Kajkac/ZTE-MC-Home-assistant