From 35457aa0adfec0c006e00bd82b6e267bf87c8b3c Mon Sep 17 00:00:00 2001
From: Nathan Reiner <nathan@nathanreiner.xyz>
Date: Mon, 27 Mar 2023 21:21:49 +0200
Subject: Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0a604a0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# **N**ate's **A**rch **I**nstall **S**cript
+
+## What it does
+
+This script helps you to setup a fully encrypted arch-setup with two-factor authentification using a *usb drive* and a *passphrase*.
+
+It also installes my dotfiles, the programs I usually use, my latest dwl build and my wayland programs (such as dmenu-wl, wlock, dbar, etc.).
+
+## How to use it
+
+Just download the latest [arch-iso](https://archlinux.org/download). Then execute the following lines to start the install script:
+
+```sh
+$ curl https://git.nathanreiner.xyz/nais/~raw/master/nais > nais
+$ chmod +x ./nais
+$ ./nais
+```
+
+Then you will get a dialog driven installer interface, which will ask you for the following:
+
+1. Root Drive
+2. Key USB Drive
+3. Username and Password (the password is also used to encrypt the boot partition)
+4. Your Time Zone
+5. Your Locale
+6. The Hostname
+
+Then select the *Install* option to bootstrap the entire system. If there are no errors
+your system will be ready to use.
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2