From c7b0b4e955d625c9d4d08370b683e62d2838651d Mon Sep 17 00:00:00 2001
From: Elias Fleckenstein
 <54945686+EliasFleckenstein03@users.noreply.github.com>
Date: Sun, 29 May 2022 23:48:50 +0200
Subject: [PATCH] Create README.md

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7eba379
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Hydra
+<img src="https://cdn8.picryl.com/photo/2016/05/14/hydra-from-bl-royal-12-c-xix-f-13-b31e4a-1024.jpg" width="500" />
+
+Lua bindings for client side minetest protocol - written in Go, using [anon5's mt package](https://github.com/anon55555/mt).
+Capable of deserializing ToClt packets and serializing ToSrv packets.
+
+Main use case are bot clients. Multiple clients can easily be spawend and polled from one script - hence the name "Hydra".
+Hydra may also be useful for integration testing or network debugging.
+
+Hydra is WIP: there are bugs, API may change any time, some packets are unimplemented and many components are yet to be added.
+
+# Installation
+Go 1.18 is required.
+`go install github.com/dragonfireclient/hydra-dragonfire@latest`
+
+# Invocation
+Due to limitations of Go, hydra can not simply be required from a Lua script. Instead, the hydra binary has to be invoked with a script as argument:
+`hydra-dragonfire file.lua <args>`. Any additional arguments `<args>` are provided to the script.
+
+# Architecture
+By default, hydra will only take care of connection and packet serialization, no state management takes place.
+Hydra is a library, not a framework: it does not organize your code and there is no module system.
+
+Multiple clients can be created independently by calling the `hydra.client` function.
+`poll` can be used on one or multiple clients to receive packets and `send` can be used to send packets.
+Only selected packets will be returned by `poll`, to avoid unnecessary conversion of packets to Lua.
+Poll will return early if the script is interrupted by a signal, one of the selected clients is disconnected or the configured timeout elapses.
+
+Additionally, different native components can be enabled per-client to manage state.
+Currently only the `auth` component is available, but components like `map`, `objs`, `inv`, `pos`, `playerlist` etc. will be added in the future.
+Components handle packets asynchronously, they will process 
+
+# Documentation
+For available packets, see `spec/client` and `spec/server`.
+
+For available utilities, see `builtin`.
+
+Documentation for native functions is yet TODO.
-- 
2.44.0