From 08b9fbbc1ee8529ac68a496ef2bc8dc4cdb5162b Mon Sep 17 00:00:00 2001
From: ErrorNoInternet <errornointernet@envs.net>
Date: Fri, 21 Feb 2025 22:32:21 -0500
Subject: [PATCH] chore: add basic readme

---
 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..e80c40b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# ErrorNoWatcher
+
+A Minecraft bot with Lua scripting support, written in Rust with [azalea](https://github.com/azalea-rs/azalea).
+
+## Features
+
+- Running Lua from
+    - `errornowatcher.lua`
+    - in-game chat messages
+    - POST requests to HTTP server
+- Listening to in-game events
+- Pathfinding (from azalea)
+- Entity and chest interaction
+
+## Usage
+
+```sh
+$ git clone https://github.com/ErrorNoInternet/ErrorNoWatcher
+$ cd ErrorNoWatcher
+$ cargo build --release
+$ # ./target/release/errornowatcher
+```
+
+Make sure the `SERVER` and `USERNAME` globals are defined in `errornowatcher.lua` before starting the bot.