readme

LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Evert Prants
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,2 +1,22 @@
 # TeemantIRC
-When will I /ever/ finish an IRC client..
+LunaSquee's third attempt at creating a working IRC client..
+
+###Running the development version
+This application requires [node.js](https://nodejs.org/) to be installed.
+
+1. Install the dependencies `npm install`
+2. Copy the configuration `cp client.config.example.toml client.config.toml`
+3. Run the server `./teemant.js`
+
+The client will be accessible at http://localhost:8080/
+
+###The (non-complete) TODO List (of things left to do)
+
+* [HIGH] Settings menu
+* [HIGH] WebIRC protocol integration
+* [MEDIUM] Theme engine
+* [NORMAL] CAP negotiation
+* [LOW] Better input
+* [LOW] irc:// URL scheme handling
+* [LOW] Connection presets
+* [LOW] More command handling (use /quote for non-integrated commands)