docs: test readthedocs

Author: jaredhendrickson13

.readthedocs.yaml

@@ -0,0 +1,14 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+mkdocs:
+  configuration: mkdocs.yml

README.md

@@ -3,10 +3,8 @@
 [![Build](https://github.com/jaredhendrickson13/pfsense-api/actions/workflows/build.yml/badge.svg?branch=next_major)](https://github.com/jaredhendrickson13/pfsense-api/actions/workflows/build.yml)
 [![Quality](https://github.com/jaredhendrickson13/pfsense-api/actions/workflows/quality.yml/badge.svg?branch=next_major)](https://github.com/jaredhendrickson13/pfsense-api/actions/workflows/quality.yml)
 
-Welcome to the pfSense-pkg-RESTAPI repository! This package offers a robust and secure REST API for pfSense firewalls.
-It is designed to streamline automation by transforming the PHP functions and processes used by pfSense's
-webConfigurator into versatile API endpoints. This document aims to provide comprehensive details about installation,
-configuration, authentication, and usage of the pfSense REST API.
+This package offers a robust and secure REST API for pfSense firewalls. It is designed to streamline automation by 
+transforming the PHP functions and processes used by pfSense's webConfigurator into versatile API endpoints.
 
 > [!TIP]
 > Detailed API endpoint documentation can be found in the [webConfigurator after installation](#webconfigurator-settings--documentation).