From fc6e1c59a57d47b8bccbedff147557d818f18efe Mon Sep 17 00:00:00 2001 From: Danny Morabito Date: Mon, 10 Mar 2025 20:21:44 +0100 Subject: [PATCH] add Readme --- Readme.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..433a2eb --- /dev/null +++ b/Readme.md @@ -0,0 +1,23 @@ +# EVE Relay + +> ⚠️ ALPHA STAGE DISCLAIMER: EVE is currently in early alpha development. Many features described here are still in development or planned for future releases. The platform is rapidly evolving, and you may encounter bugs, incomplete functionality, or significant changes between versions. We welcome early adopters and contributors who share our vision, but please be aware of the platform's developmental status. + +# Requirements + +- Deno v2.2.1 or higher + ```bash + curl -fsSL https://deno.land/install.sh | sh + ``` + +# Getting Started + +``` +# Clone the Eve-Relay repo +git clone https://git.arx-ccn.com/Arx/Eve-Relay Relay + +# Navigate into the Relay directory +cd Relay + +# start the dev relay +deno task dev +```