diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9b1e531
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# The NixOS Installer
+
+This installer is named after my doggo Onyxia.
+
+## Starting the Installer
+
+```bash
+sh <(curl -L https://gitlab.com/ahoneybun/nyxi-installer/-/raw/main/install.sh)
+```
+
+At the core of this installer it does the following:
+
+- Partition the drive of your choice using the `rsfdisk` crate.
+- Uses `flake.nix` to set certain modules depending on the system like nixos-hardware for the Pinebook Pro
+- Installs a base of NixOS (`configuration.nix`)
+
+nix files are from [this repo](https://gitlab.com/ahoneybun/nix-configs/) but that can be changed as needed.
+
+This sets the hashedPassword to my own so you will need to update it to match your own as well as the username. I created the hash with this command:
+
+```bash
+mkpasswd -m sha-512
+```