From fef5c8a0ea6bd530d613f42578629583101e698b Mon Sep 17 00:00:00 2001
From: n07070 <social+git@n07070.xyz>
Date: Fri, 1 Mar 2024 11:00:17 +0100
Subject: [PATCH] Add README

---
 README.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 86 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b78231d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,86 @@
+<p align="center">
+    <img src="https://github.com/hubblo-org/scaphandre/raw/main/docs_src/scaphandre.cleaned.png" width="200">
+</p>
+<h1 align="center">
+  Scaphandre
+</h1>
+
+<h3 align="center">
+    Your tech stack doesn't need so much energy ⚡
+</h3>
+
+
+This role installs [scaphandre](https://github.com/hubblo-org/scaphandre) and configures it's exporters.
+
+Requirements
+------------
+
+The role in itself does not have other requirements than Scaphandre. It's written with Debian Bookworm in mind.
+
+Role Variables
+--------------
+```
+scaphandre_arch: "deb12-arm64"
+```
+The architecture targeted.
+
+```
+scaphandre_version: "1.0.0"
+```
+Scaphandre's version.
+
+```
+scaphandre_home_dir: "/opt/scaphandre"
+```
+The home directory for the scaphandre user.
+
+```
+scaphandre_exporter: "prometheus"
+```
+
+Which exporter should we use. You can choose between :
+
+- `prometheus`
+- `prometheus-push`
+- `json`
+- `riemann`
+- `warp10`
+
+scaphandre_exporter_web_listen_address: "localhost"
+
+scaphandre_exporter_web_listen_port: "8085"
+
+scaphandre_web_telemetry_path: "power-metrics"
+
+```
+scaphandre_web_telemetry_path: "/power-metris"
+```
+
+On which path will Scaphandre expose it's metrics.
+
+
+
+
+Dependencies
+------------
+
+N/A
+
+Example Playbook
+----------------
+
+Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+
+    - hosts: servers
+      roles:
+         - role: hubblo.scaphandre
+
+License
+-------
+
+AGPLv3
+
+Author Information
+------------------
+
+Written by [N07070](https://n07070.xyz).
\ No newline at end of file