Finalising documentation and dependencies

README.md

@@ -11,7 +11,11 @@
 
 #SockBot Markov
 
-Markov plugin for [SockBot](https://sockbot.rtfd.org/en/latest/).
+Markov plugin for [SockBot](https://sockbot.rtfd.org/en/latest/) version 2.0.0 or later; generated semi-coherent posts using a Markov chain generator.
+
+##Usage
+
+No special syntax is required; simply summon, reply, or send a private message.
 
 ##Developers
 

docs/configuration.md

@@ -0,0 +1,61 @@
+#Configuration
+
+SockBot Markov requires a text file to generate the corpus that powers the Markov chain; this is specified by the `corpus` setting.
+
+YAML example:
+```
+---
+core:
+  username: username
+  password: password
+  owner: owner
+plugins:
+  sockbot-markov:
+    corpus: '../path/to/corpus.txt'
+```
+
+JSON example:
+```
+{
+  "core": {
+    "username": "username",
+    "password": "password",
+    "owner": "owner"
+  },
+  "plugins": {
+    "sockbot-markov": {
+      "corpus": "../path/to/corpus.txt"
+    }
+  }
+}
+```
+
+Note that these examples assume an NPM-based installation; other installation methods may require the path to `Math.js` (without file extension) be specified explicitly.
+
+YAML example:
+```
+---
+core:
+  username: username
+  password: password
+  owner: owner
+plugins:
+  '../path/to/Markov':
+    corpus: '../path/to/corpus.txt'
+```
+
+JSON example:
+```
+{
+  "core": {
+    "username": "username",
+    "password": "password",
+    "owner": "owner"
+  },
+  "plugins": {
+    "../path/to/Markov": {
+      "corpus": "../path/to/corpus.txt"
+    }
+  }
+}
+```

docs/index.md

@@ -0,0 +1,29 @@
+#SockBot Markov
+
+Markov plugin for [SockBot](https://sockbot.rtfd.org/en/latest/) version 2.0.0 or later; generated semi-coherent posts using a Markov chain generator.
+
+##Usage
+
+No special syntax is required; simply summon, reply, or send a private message.
+
+##Developers
+
+SockBot Markov is developed by [SockDrawer](https://github.com/SockDrawer) developer [RaceProUK](https://github.com/RaceProUK).
+
+##Quickstart Guide
+
+* Create a folder to install to
+* Run `npm install sockbot`
+* Run `npm install sockbot-markov`
+* Create a configuration file called `Config.yml` in that folder with the following contents:
+```
+---
+core:
+  username: [the bot's username]
+  password: [the bot's password]
+  owner: [your username]
+plugins:
+  sockbot-markov:
+    corpus: '../path/to/corpus.txt'
+```
+* Run `sockbot Config.yml`

docs/installation.md

@@ -0,0 +1,25 @@
+#Installation
+
+SockBot Markov, like SockBot 2.0, is written entirely in JavaScript using ES6 syntax.
+As such, it has the same environment compatibility and testing procedures; see the [SockBot documentation](https://sockbot.readthedocs.org/en/latest/installation/) for details.
+
+##Environment setup
+
+Sockbot Markov requires the same environment as SockBot 2.0; see the [SockBot documentation](https://sockbot.readthedocs.org/en/latest/installation/) for details.
+
+##Installation
+
+The preferred method of installation is via NPM; simply run this command within the SockBot installation folder:
+```
+npm install sockbot-markov
+```
+
+Other methods of installation are possible e.g. cloning the git repository, but only installation via NPM is supported.
+
+##Post Install Setup
+
+If you installed via NPM skip this step as NPM has already installed all necessary dependencies.
+Otherwise you will need to run the following command in the folder where you installed SockBot Markov:
+```
+npm install
+```

docs/license.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 RaceProUK
+
+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.
+

docs/special thanks.md

@@ -0,0 +1,3 @@
+#Special Thanks
+
+For creating [SockBot](https://sockbot.readthedocs.org/en/latest/) and just generally being awesome: [Accalia de Elementia](https://github.com/AccaliaDeElementia)

package.json

@@ -15,7 +15,7 @@
     "iojs": ">=1.7"
   },
   "dependencies": {
-    "sockbot": "^2.10.2"
+    "sockbot": "^2.0.0"
   },
   "devDependencies": {
     "chai": "^3.2.0",