From 0a4181dd62914e4aeb414acef449584a9239c97d Mon Sep 17 00:00:00 2001
From: LarsZauberer <wasser.ian@gmail.com>
Date: Fri, 17 May 2024 08:20:37 +0200
Subject: [PATCH] Added nix installation guide

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

diff --git a/README.md b/README.md
index f689fa9..9a2fde6 100644
--- a/README.md
+++ b/README.md
@@ -2,17 +2,47 @@
 
 A TUI based [alternative](https://thealternative.ch) to [MonkeyType](https://monkeytype.com) written in rust.
 
+## Installation
+
+### Cargo
+
+Simply type
+
+```sh
+cargo install crabtype
+```
+
+### Nix
+
+To build CrabType for nix just add this derivation to your nix config
+
+```nix
+    rustapple = pkgs.callPackage (pkgs.fetchFromGitHub {
+        owner = "einsJannis";
+        repo = "CrabType";
+        rev = "<Git Revision>";
+        sha256 = "<Git SHA>";
+    }) {};
+```
+
+You can figure out the revision and the sha265 by running the application `nix-prefetch-git`
+
 ## Run
 
 ```sh
 crabtype [options...]
 ```
+
 ### Options
+
 ```
 -g|--gamemode <file>
 ```
+
 Changes the game mode to the one defined in `<file>`. This file must contain each possible text, separated by newlines.
+
 ```
 -u|--user <file>
 ```
+
 Sets the user file to `<file>`, which is the file which stores the stats in a TOML format.