From db8383e9e957483c768a485ad6e09ed63af8bba2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Abdulkadir=20Furkan=20=C5=9Eanl=C4=B1?= <me@abdulocra.cy>
Date: Sat, 15 Jun 2024 08:37:30 +0200
Subject: [PATCH] Initial commit of README.md.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Abdulkadir Furkan Şanlı <me@abdulocra.cy>
---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 34b37b9..87dba21 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
-# darkirc-container
+# DarkIRC Container
 
+This repository houses an OCI/Docker container image for DarkIRC.
+
+DarkIRC is the main mode of communication for the [DarkFi](https://dark.fi) project.
+
+## Usage
+
+Run it with Docker:
+
+```shell
+docker run -d --name darkirc -p 6667:6667 git.abdulocra.cy/abdulocracy/darkirc:latest
+```
+
+Or run it with Docker Compose:
+
+```yaml
+services:
+  darkirc:
+    container_name: darkirc
+    image: git.abdulocra.cy/abdulocracy/darkirc:latest
+    ports:
+      - "6667:6667"
+```