Initial commit of README.md.

Signed-off-by: Abdulkadir Furkan Şanlı <me@abdulocra.cy>
2024-06-15 08:37:30 +02:00 · 2024-06-15 08:37:30 +02:00 · db8383e9e9
commit db8383e9e9
parent cf6c74799d
1 changed files with 23 additions and 1 deletions
--- 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"
+```