sample file, readme and update deps

brunoventura · brunoventura · commit 5997bab9cd1a · 2016-03-01T03:35:38.000-03:00
diff --git a/.gitignore b/.gitignore
@@ -33,4 +33,4 @@ node_modules
 .node_repl_history
 >>>>>>> b98f6a419c2b5cf9f301e9a9b0f3ec9488a5a269
 
-config/**/*
+config/production.json
diff --git a/README.md b/README.md
@@ -0,0 +1,32 @@
+# CTF-BOT
+
+A simplistic bot for IRC channel. With a dynamic module reload (Hot-reload) to create a changeable bot on-the-fly :dancer:
+
+### Configuration
+
+You can set the envoironment configuration file inside config folder, the file must have the same name of the desired env. There's a sample development config file :)
+
+### Funcionalities
+
+  - !nextctf: Return next CTF from [ctftime]
+
+### Todos
+
+ - ~~Dynamic module loader;~~ (by [@brunoventura]).
+ - ~~CTF-BOT give voice to users;~~ (by [@fernandoGuisso])
+ - CTF-BOT show national events in !nex
+ - ~~Extract config params from script;~~ (by [@brunoventura]).
+
+### Installation
+  ```sh
+$ npm install
+```
+
+### Run
+  ```sh
+$ node app.js
+```
+
+   [ctftime]: <https://ctftime.com/upcoming>
+   [@fernandoGuisso]: <https://github.com/fernandoGuisso>
+   [@brunoventura]: <https://github.com/brunoventura>
diff --git a/config/development.json b/config/development.json
@@ -0,0 +1,8 @@
+{
+    "server": "rajaniemi.freenode.net",
+    "botNick": "ctfbot-test",
+    "password": "",
+    "channels": [
+        "#ctf-bot-test"
+    ]
+}
diff --git a/package.json b/package.json
@@ -10,8 +10,8 @@
   "license": "ISC",
   "dependencies": {
     "cheerio": "^0.20.0",
-    "hotswap": "^1.1.0",
     "irc": "^0.4.1",
-    "request": "^2.69.0"
+    "request": "^2.69.0",
+    "watch": "^0.17.1"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,8 @@`
`10`	`10`	`"license": "ISC",`
`11`	`11`	`"dependencies": {`
`12`	`12`	`"cheerio": "^0.20.0",`
`13`		`- "hotswap": "^1.1.0",`
`14`	`13`	`"irc": "^0.4.1",`
`15`		`- "request": "^2.69.0"`
	`14`	`+ "request": "^2.69.0",`
	`15`	`+ "watch": "^0.17.1"`
`16`	`16`	`}`
`17`	`17`	`}`