From b9cb3a39ec32fc6a2166de07004a05e6865167b6 Mon Sep 17 00:00:00 2001
From: mrkubax10 <mrkubax10@onet.pl>
Date: Tue, 5 Sep 2023 11:34:45 +0200
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dec49e9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# irclogger_web
+irclogger_web is a highly configurable IRC logger with web frontend. It's written in Perl.
+
+## Installation
+1. You need to have Perl and SQLite3 interpreter installed.
+2. Following Perl packages have to be installed: [DBI](https://metacpan.org/pod/DBI), [DBD::SQLite](https://metacpan.org/pod/DBD::SQLite).
+3. Run `./prepare_database.sh` to create SQLite3 database for storing users, servers and logged channels.
+4. See `configuration.pm` and adjust it to your needs.
+5. Run `perl main.pl` to start HTTP server and logger.