From 66e39c1d4b4f5819cd1d7439e731e70253a8ca21 Mon Sep 17 00:00:00 2001
From: trivernis <trivernis@protonmail.com>
Date: Mon, 17 Oct 2022 21:31:17 +0200
Subject: [PATCH] Add script description to README

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/README.md b/README.md
index e7eb22a..650b7cb 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,37 @@
 # tourmaline
+
 Tourmaline is a (planned) agnostic, asynchronous and awesome installer framework
+
+
+## Usage
+
+Just run `cargo run -- help` or `trm help` for now.
+
+
+## Scripts
+
+Scripts for all supported distros are stored in the `config` folder of this repository.
+Each distro has its own folder with several subfolders corresponding to all integration tasks.
+
+```
+<distro>
+  | <task>
+      | up.nu
+      | down.nu 
+  | <task>
+      | up.nu
+      | down.nu
+```
+
+The `up.nu` scripts contain the required steps to apply the change described by the task.
+This can include installing packages, creating configuration files and starting systemd units.
+
+The `down.nu` scripts contain the steps to revert the change applied by a task. These scripts will
+later be used to offer functionalities like reinstalling grub or changing installed kernels.
+ 
+
+# License
+
+> GPL v3
+
+See LICENSE.