From b71e221b1f8120174247fce24409697e587e5615 Mon Sep 17 00:00:00 2001
From: Jan-Stefan Janetzky <git@gottz.de>
Date: Thu, 15 Mar 2018 16:02:33 +0000
Subject: [PATCH] updated readme.md

---
 readme.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 59 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index 00a3575..1c11e7d 100644
--- a/readme.md
+++ b/readme.md
@@ -1 +1,59 @@
-woop woop
+# w0bm IRC Bot
+
+This README outlines the details of collaborating on this silly application.
+this bot primarily connects to #w0bm on [n0xy.net](https://n0xy.net) and provides useful additions to the irc channel.
+
+## Prerequisites
+
+You will need the following things properly installed on your potato.
+
+* [Git](https://git-scm.com)
+* [Node.js](https://nodejs.org) (with npm. just use nvm and install `lts/carbon`)
+* libicu-dev (just do something like this: `apt install libicu-dev`)
+* access to the w0bm infrastructure (or else you will not be able to connect to the database)
+
+## Installation
+
+* `git clone git@gitfap.de:w0bm/w0bmircbot.git ircbot`
+* `cd ircbot`
+* `npm install`
+
+## Development Dependencies
+
+* you need a valid config file aswell as access to the w0bm database
+
+## Update Dependencies
+
+* `npm install npm-check-updates -g`
+* `ncu`
+
+## Running / Development
+
+* `node .` (will greet you with a repl as defined in index.js)
+
+### Code Generators
+
+* would be nice.. but fuck you
+
+### Running Tests
+
+* running what? don't make me lol
+
+### Linting
+
+* plz stop
+
+### Building
+
+* this is the build.
+
+### Deploying
+
+* none of your business but the systemd unit file is there if you really intent to use this for anything.
+* you'll need to change a bunch of magic values first.
+
+## Further Reading / Useful Links
+
+* [nvm](https://github.com/creationix/nvm)
+* [#w0bm on n0xy](ircs://irc.n0xy.net:6697/#w0bm)
+* [w0bm.com](https://w0bm.com)
\ No newline at end of file