update README and add docker compose

CHANGELOG.md

@@ -6,9 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- added in-memory cache to reduce API strain (#4)
+
 ### Changed
 - renamed the score metric from `ntppool_score` to `ntppool_server_score`
 - fixed some debug logs
+- update readme to reflect new repo
 
 ### Removed
 - unneccessary `server` label in metrics

CONTRIBUTING.md

@@ -1,12 +1,12 @@
 # Contributing
 
-We use GitLab to manage reviews of pull requests.
+I use my own [Forgejo Instance](https://code.lila.network) to manage issues and pull requests.
 
 * If you have a trivial fix or improvement, go ahead and create a pull request,
   addressing (with `@...`) the maintainer of this repository (see
   [MAINTAINERS.md](MAINTAINERS.md)) in the description of the pull request.
 
-* If you plan to do something more involved, first please create [a new issue](https://gitlab.com/adoralaura/ntppool-exporter/-/issues/new).
+* If you plan to do something more involved, first please [send me a mail]( mailto:adora@lila.network?subject=%5Bntppool-exporter%5D).
 
 # What to contribute
 

README.md

@@ -2,16 +2,13 @@
 
 This exporter is @adoralaura s try to display server scores from servers in [ntppool.org](https://www.ntppool.org) in a format which [Prometheus](https://prometheus.io/) can ingest.
 
-
-
-
-
 # Usage
 
 ## Installation
 
-Binaries can be downloaded soon from the [GitLab releases page](https://gitlab.com/adoralaura/ntppool-exporter/-/releases) and need no
+Pre-built docker images can be found at [Docker Hub](https://hub.docker.com/r/lauralani/ntppool-exporter). A sample `docker-compose.yml` can be [found here](docker-compose.yml).
-special installation
+
+Binaries can be built by cloning this repository and run `go build main.go` with [Golang](https://go.dev/) installed.
 
 ## Running
 

docker-compose.yml

@@ -0,0 +1,8 @@
+services:
+  ntppool_exporter:
+    image: lauralani/ntppool-exporter:latest
+    restart: always
+    ports:
+      - '127.0.0.1:43609:43609'
+    # Add this to enable debug logging:
+    # command: --log.level=debug