From d5886843c636881df5b9ef8cd251bb925bb94467 Mon Sep 17 00:00:00 2001 From: hiimgoodpack Date: Mon, 25 Jan 2021 14:48:21 -0500 Subject: [PATCH] Better README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6282e5..274dd8d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ # brainlet-irc -Brainlet to IRC translation layer +Unofficial Brainlet to IRC translation layer + +**WARNING: You should not expose the IRC server to the public! There are multiple known +security issues in the dependencies of the module hosting the actual IRC server.** + +# Installing + +```bash +git clone --depth=1 --recurse-submodules https://git.hippoz.xyz/hiimgoodpack/brainlet-irc.git +cd brainlet-irc +npm install +pushd ircd.js; npm install; popd +pushd brainlet-lib; npm install; popd +``` # Technical notes