add Readme

This commit is contained in:
Danny Morabito 2025-03-10 20:21:44 +01:00
parent 9bef51a027
commit fc6e1c59a5
Signed by: dannym
GPG key ID: 7CC8056A5A04557E

23
Readme.md Normal file
View file

@ -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
```