Publish to PyPI

README.md

@@ -2,13 +2,14 @@
 
 This is a plugin that scans the specified directories and files for JSON Schema files, converts them to markdown and builds them into your documentation.
 
-**Breaking Change**  This version can introduce some breaking change. Markdown output is now wrtie to documentation directory (`${docs_dir/schema}`)instead of `site/schema`. If your documentation was in `site` folder, this will change nothing. Use the new `output` options for control it if needed.
+> [!IMPORTANT]
+> This fork introduces some breaking change over the original `mkdocs-schema-reader`. Markdown output is now written to the documentation directory (`${docs_dir/schema}`)instead of `site/schema`. If your documentation was in `site` folder, this will change nothing. Use the new `output` options for control it if needed.
 
 ## Setup
 
 Install the plugin using pip:
 
-`pip install mkdocs-schema-reader`
+`pip install mkdocs_schema_reader_2`
 
 Activate the plugin in `mkdocs.yml`:
 ```yaml
@@ -29,7 +30,8 @@ plugins:
 
 Specified directories will be scanned for schema json files, so consider specifying individual files for expansive directories.
 
-> **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.
+> [!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].
 

requirements.txt

@@ -1,2 +1,2 @@
-mkdocs>=1.0.3
+mkdocs>=1.0.4
 jsonschema2md>=0.3.0

setup.py

@@ -5,15 +5,15 @@
     long_description = fh.read()
 
 setup(
-    name="mkdocs_schema_reader",
+    name="mkdocs_schema_reader_2",
     version="0.12.1",
-    description="A MkDocs plugin to collate json schema files and convert them into markdown files",
+    description="A MkDocs plugin to embed json schema files as markdown within your documentation.",
     long_description=long_description,
     long_description_content_type="text/markdown",
     keywords="mkdocs, schema, json, plugin",
-    url="https://github.com/magicaljellybeans/mkdocs_schema_reader",
-    author="Tom Robinson",
-    author_email="[email protected]",
+    url="https://github.com/mysiki/mkdocs_schema_reader",
+    author="",
+    author_email="",
     license="MIT",
     python_requires=">=3.6",
     install_requires=["mkdocs>=1.0.4", "jsonschema2md>=0.3.0"],