Better README

This commit is contained in:
hiimgoodpack 2021-01-25 14:48:21 -05:00
parent 3b998f16a8
commit d5886843c6
Signed by: hiimgoodpack
GPG key ID: 4E0E62733C14AE69

View file

@ -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