Add README.md

5 years ago · e9cba7c2a4
1 changed files with 18 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,18 @@
+ircd-js
+===
+
+A simple IRCd project to provide an IRCd.
+
+Running
+===
+
+```bash
+# Install all dev dependencies
+npm install
+
+# Run mocha tests
+npm test
+
+# Start the index.js
+npm start
+```