Be a good citizen and add a README

friends-of-freeswitch · Aug 6, 2016 · 33dff63 · 33dff63
1 parent 46b4b8a
commit 33dff63
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -0,0 +1,12 @@
+FreeSWITCH Prometheus Module
+--------------------------------
+
+This module exposes FreeSWITCH metrics for scraping by
+`Prometheus
+<https://prometheus.io/>`_.
+
+You'll need to have FreeSWITCH rust bindings
+`freeswitchrs
+<https://gitlab.com/wiresight/freeswitchrs/>`_.
+
+Include this module in the freeswitchrs directory to build it.