prepare for packaging

LICENCSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Tom Robinson
+
+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

@@ -0,0 +1,24 @@
+# mkdocs schema reader plugin 
+
+This is a plugin that scans the entire repository for JSON Schema files, converts them to markdown and builds them into your documentation.
+
+## Setup
+
+Install the plugin using pip:
+
+`pip install mkdocs-schema-reader`
+
+Activate the plugin in `mkdocs.yml`:
+```yaml
+plugins:
+  - search
+  - mkdocs-schema-reader
+```
+
+> **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.
+
+More information about plugins in the [MkDocs documentation][mkdocs-plugins].
+
+## Usage
+
+Just activate the plugin and it will operate when normal mkdocs command are used like `mkdocs serve'

setup.py

@@ -1,15 +1,19 @@
 from setuptools import setup, find_packages
 
 
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
 setup(
     name="mkdocs_schema_reader",
     version="0.1.0",
     description="A MkDocs plugin to collate json schema files and convert them into markdown files",
-    long_description="",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     keywords="mkdocs, schema, json",
-    url="",
+    url="https://github.com/magicaljellybeans/mkdocs_schema_reader",
     author="Tom Robinson",
-    author_email="tome.robin@gail.com",
+    author_email="tome.robin@gmail.com",
     license="MIT",
     python_requires=">=2.7",
     install_requires=["mkdocs>=1.0.4", "jsonschema2md"],