From 3f63e2262fd69ecc6e8d252ce875c7813b15dca3 Mon Sep 17 00:00:00 2001
From: pixtaded <pixtaded@noreply.localhost>
Date: Sun, 22 Dec 2024 23:00:03 +0300
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5e163d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# CRAB (Crimean RAC Bundle)
+
+CRAB is a Java client and server implementation of the RAC (Real Address Chat) protocol, designed to facilitate communication in a lightweight and efficient manner.
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Usage](#usage)
+- [RAC Protocol](#rac-protocol)
+
+## Overview
+
+CRAB aims to provide a simple and effective implementation of the RAC protocol, which is humorously referred to as Mr. Sugoma’s “IRC killer.” The protocol allows clients to send messages to a server, which processes them according to predefined message types.
+
+## Installation
+
+To get started with CRAB, follow these steps:
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://gitea.bedohswe.eu.org/pixtaded/crab.git
+   cd crab
+   ```
+
+2. **Build the project:**
+   Ensure you have Java Development Kit (JDK) of version 17 or higher installed. You can build the project using Maven:
+   ```bash
+   ./gradlew clean build
+   ```
+
+3. **Run the bundle**: You will have the built .tar and .zip packages in ./build/distributions directory.
+
+## Usage
+
+Once the server is running, clients can connect to it and send messages according to the RAC protocol. The client will need to specify the server's address and port to establish a connection.
+
+## RAC Protocol
+
+You can see the RAC protocol documentation [here](https://bedohswe.eu.org/text/rac/protocol.md.html).
\ No newline at end of file