From 0b7839e61f07b760cd402aa3f08a40e959a5a96e Mon Sep 17 00:00:00 2001
From: badbl0cks <4161747+badbl0cks@users.noreply.github.com>
Date: Wed, 24 May 2023 18:22:14 -0700
Subject: [PATCH] Add project documentation

- Create comprehensive README with feature overview
- Include build instructions for devkitPro toolchain
- Add usage instructions and safety warnings
- Professional documentation for project release
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..63f527d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# BOTW Completer
+
+Nintendo Switch homebrew tool for managing Korok seed locations in Breath of the Wild.
+
+## Features
+
+- Add missing Korok seed pins to your map
+- Remove all existing map pins 
+- Fix corrupted map pin data
+- Sort Koroks by distance from player
+
+## Building
+
+Requires devkitPro toolchain:
+
+```bash
+make
+```
+
+## Usage
+
+Run via homebrew launcher. Use the on-screen menu to select options.
+
+**Warning:** This modifies save data. Back up your saves first.
\ No newline at end of file