From d36bf2981e438855a0da5904d9131b2737da6107 Mon Sep 17 00:00:00 2001
From: Oxbian <got.dacs@slmail.me>
Date: Mon, 24 Apr 2023 13:15:49 +0200
Subject: Adding matrix-sender submodules & logwatch.sh

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index fd496b6..879681c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
 # matrix-monitoring
-Some scripts to monitor your server and send data to matrix.
+------
+
+Some scripts to monitor your server and send data to matrix. Those scripts use a [matrix-sender](), another script I made to send message to matrix.
+
+## Install
+
+To install this project & load submodules, use:
+
+```bash
+git clone --recurse-submodules https://github.com/Oxbian/matrix-monitoring.git
+```
+
+Or you can use:
+```bash
+git clone https://github.com/Oxbian/matrix-monitoring.git
+git submodule update --init --recursive
+```
+
+## Contributing
+
+If you want to contribute, make a pull request with your contribution.
+
+## License
+
+This project is under the GPLv3 license, you can use it in your project but not in closed sources ones.  
+Sharing project is what make the world live, think about it.
-- 
cgit v1.2.3