Switched from README.md to README.rst

README.md

@@ -1,3 +0,0 @@
-# hetrixtools-freebsd
-
-A python-based script to provide the JSON-based output for HetrixTools server monitoring

README.rst

@@ -0,0 +1,32 @@
+.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold
+    :alt: Project generated with PyScaffold
+    :target: https://pyscaffold.org/
+
+|
+
+===================
+hetrixtools-freebsd
+===================
+
+
+    A Python script that collects monitoring data from FreeBSD_ hosts for HetrixTools_
+
+
+The original `Linux-based HetrixTools`_ script is based on ``bash`` and uses a lot of ``sed`` and silly tricks to parse various kinds of Linux data. At the end of the day, we need to produce some JSON output with some values Base64 encoded and submit it to the HetrixTools monitoring service. This allows them to see things like RAM usage, disk usage, load average, etc. The Linux-based script uses a lot of Linux-specific mechanisms like querying ``/proc`` and parsing it. These methods don't work on FreeBSD.
+
+This aims to be a long-lived daemon process in python that periodically wakes up, gathers some data, uploads it to the API, and goes to sleep.
+
+I was going to adapt the `OpenBSD agent`_ but that was (a) written against an older version of the HetrixTools API, and (b) still using too much ``bash`` and ``sed`` nonsense. Python seemed like the right tool for the job.
+
+
+.. _pyscaffold-notes:
+.. _HetrixTools: https://hetrixtools.com/
+.. _FreeBSD: https://freebsd.org/
+.. _Linux-based HetrixTools: https://github.com/hetrixtools/agent
+.. _OpenBSD agent: https://github.com/sholwe/hetrixtools-agent-openbsd
+
+Note
+====
+
+This project has been set up using PyScaffold 4.5. For details and usage
+information on PyScaffold see https://pyscaffold.org/.