From 10fc937bbb527fbf419a7a6dc2bf4edd4c340b48 Mon Sep 17 00:00:00 2001
From: xezo360hye <xezo360hye@gmail.com>
Date: Sat, 6 Jul 2024 20:39:31 +0300
Subject: [PATCH] Updated README with instructions

---
 README.md | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index dc385cf..c15807e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,21 @@
-# nethack.nix
+# Nethack configuration module for home-manager
 
-Nethack configuration module in Nix, for use with home-manager
\ No newline at end of file
+TLDR: [home-manager](https://github.com/nix-community/home-manager/) module for easier `.nethackrc` configuration.
+
+## Usage
+
+1. Add this repo to inputs:
+```nix
+inputs.nethack.url = git+ssh://git@git.psf.lt/xezo360hye/nethack;
+```
+
+2. Use the input as module:
+```nix
+outpus.homeConfigurations."user@host" = home-manager.lib.homeManagerConfiguration {
+  modules = [
+    nethack.homeManagerModules.nethack
+
+    ./home.nix
+  ];
+};
+```