Documentation updates

Author: commitconfirmed

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

README.md

@@ -85,8 +85,50 @@ interfaces:
     ipv6: { jsnac_type: ipv6_cidr }
 ```
 
-A full list of jsnac_types is available in the documentation
+A full list of jsnac_types is available in the documentation (readthedocs coming soon)
 
 ## Usage
 
-You can use jsnac from the command line or by importing it and calling InferSchema?
+### CLI
+
+```bash
+# Print the help message
+jsnac -h
+
+# Build a JSON schema from a YAML file (default file is jsnac.schema.json)
+jsnac -f data/example-jsnac.yml
+
+# Build a JSON schema from a YAML file and save it to a custom file
+jsnac -f data/example-jsnac.yml -o my.schema.json
+
+# Increase the verbosity of the output
+jsnac -f data/example-jsnac.yml -v
+```
+
+### Library
+```python
+"""
+This example demonstrates how to use the jsnac library to build a JSON schema from a YAML file in a Python script.
+Example yml file is available here: <https://www.github.com/commitconfirmed/jsnac/blob/main/data/example-jsnac.yml>
+"""
+from jsnac.core.infer import SchemaInferer
+
+def main():
+    # Create a SchemaInferer object
+    jsnac = SchemaInferer()
+
+    # Load the YAML data however you like into the SchemaInferer object
+    with open('data/example-jsnac.yml', 'r') as file:
+        data = file.read()
+    jsnac.add_yaml(data)
+
+    # Loading from JSON directly is also supported if needed
+    # jsnac.add_json(json_data)
+
+    # Build the JSON schema
+    schema = jsnac.build()
+    print(schema)
+
+if __name__ == '__main__':
+    main()
+```

pyproject.toml

@@ -7,11 +7,10 @@ name = "jsnac"
 version = "0.1.0"
 description = "JSON Schema (for) Network as Code: Build JSON schemas from (un)modified YAML files"
 authors = ["Andrew Jones <jsnac@commitconfirmed.com>"]
-license = "Apache 2.0"
+license = "MIT"
 readme = "README.md"
 repository = "https://github.com/commitconfirmed/jsnac"
 classifiers = [
-        "License :: OSI Approved :: Apache Software License",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",