update docs

Author: willforde

docs/api/index.rst

@@ -1,12 +1,7 @@
 API
 ===
 
-fhfghfghfgh
-fdghfdghdfghdfgh
-dfg
-h
-fdgh
-dfghdfghfdghfdhgfdh
+Table of Contents.
 
  .. toctree::
     :maxdepth: 1

docs/index.rst

@@ -1,12 +1,26 @@
-.. CodeQuick documentation master file, created by
-   sphinx-quickstart on Sun Aug  6 02:34:34 2017.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 ============
 Introduction
 ============
-sdasdfasf asdf asfd asdf asdf asdf asdf asdf asdf
+Codequick is a framework for kodi add-on's. The goal of this framework is to simplify add-on development.
+This is achieved by reducing the amount of boilerplate code to a minimum, automating tasks like route dispatching
+and sort method selection. Ultimately allowing the developer to focus primarily on scraping content from websites
+and passing it to kodi.
+
+This framework utilizes 3 other kodi modules.
+    * urlquick: https://github.com/willforde/urlquick
+    * htmlement: https://github.com/willforde/python-htmlement
+    * youtube.dl: https://forum.kodi.tv/showthread.php?tid=200877
+
+Urlquick is a light-weight http client with requests like interface.
+Featuring persistent connections and caching support.
+
+Htmlement is a pure-python HTML parser which aims to be faster than beautifulsoup.
+And like beautifulsoup, it will also parse invalid html.
+Parsing is then achieved by utilizing ElementTree with XPath expressions.
+
+Youtube-dl is a video downloader written in python and released in the public domain.
+It supports 270+ sites and is updated frequently. Can be used to parse video sources and forward them to kodi.
+
 
 Contents
 ========

docs/tutorial.rst

@@ -1,9 +1,23 @@
 ########
 Tutorial
 ########
-sdasdfasf asdf asfd asdf asdf asdf asdf asdf asdf
-ghjghjghjghj
-ghj
-gh
-jgh
-jghjgjh
+Here we will document the creation of an add-on.
+In this case, plugin.video.metalvideo. This will be a simplifyed version of the full add-on
+witch can be found @ https://github.com/willforde/plugin.video.metalvideo
+
+First thing is to import the required codequick components.
+
+    * ``Route`` will be used to list folder items.
+    * ``Resolver`` will be used to resolve video urls.
+    * ``Listitem`` is used to create items within kodi.
+    * ``run`` is the function that controls the execution of the add-on.
+
+.. code-block:: python
+
+    from codequick import Route, Resolver, Listitem, run
+
+
+Next we will create the root function that will be the starting point for the add-on.
+It is very important that the root function is called 'root'.
+
+The root function will have to be registered so codequick can find it.

script.module.codequick/lib/codequick/__init__.py

@@ -21,13 +21,9 @@
 start_time = __import__("time").time()
 
 # Package imports
-from codequick.storage import PersistentDict, PersistentList
-from codequick.support import dispatcher as _dispatcher
+from codequick.support import run
 from codequick.resolver import Resolver
 from codequick.listing import Listitem
 from codequick.script import Script
 from codequick.route import Route
-from codequick import utils
-
-# Convenience function to call dispatcher
-run = _dispatcher.dispatch
+from codequick import utils, storage

script.module.codequick/lib/codequick/script.py

@@ -183,7 +183,7 @@ def register_metacall(func, *args, **kwargs):
         dispatcher.metacalls.append(callback)
 
     @staticmethod
-    def log(msg, args, lvl=10):
+    def log(msg, args=None, lvl=10):
         """
         Logs a message with logging level of 'lvl'.
 
@@ -326,6 +326,8 @@ def request(self):
             >>> def root(plugin):
             >>>     html = plugin.request.get("http://example.com/index.html")
             >>>     root_element = html.parse()
+            >>>     print(root_element)
+            >>>     "xml.etree.ElementTree.Element"
         """
         return urlquick.Session()
 

script.module.codequick/lib/codequick/support.py

@@ -365,3 +365,4 @@ def build_path(path=None, query=None, **extra_query):
 
 # Dispatcher to manage route callbacks
 dispatcher = Dispatcher()
+run = dispatcher.dispatch