From 2fd241d0d43125f748b110a54363549f2de6ede2 Mon Sep 17 00:00:00 2001
From: Owen <owen@txv.io>
Date: Mon, 25 Aug 2025 16:37:40 -0700
Subject: [PATCH] Update readme

---
 README.md | 40 +++++++++++++++++++++++-----------------
 1 file changed, 23 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index 66c5f11..592c4b1 100644
--- a/README.md
+++ b/README.md
@@ -1,44 +1,50 @@
-# Mintlify Starter Kit
+# Pangolin Documentation
 
-Use the starter kit to get your docs deployed and ready to customize.
+Welcome to the official documentation for [Pangolin](https://github.com/fosrl/pangolin), a modern reverse proxy and networking solution. This documentation site is hosted at [docs.digpangolin.com](https://docs.digpangolin.com) and provides comprehensive guides, API references, and resources for getting started with Pangolin.
 
-Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with
+## About This Documentation
 
-- Guide pages
-- Navigation
-- Customizations
-- API reference pages
-- Use of popular components
+This documentation covers everything you need to know about Pangolin, including:
+- Installation and setup guides
+- Configuration options
+- API reference
+- Self-hosting instructions
+- Development and contribution guidelines
 
-**[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**
+All contributions to improve this documentation are welcome! Feel free to submit issues or pull requests to help make these docs better for everyone.
 
-## Development
+## Development & Contributing
 
-Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
+This documentation site is built using [Mintlify](https://mintlify.com). If you'd like to contribute to the documentation or run it locally for development, follow the instructions below.
 
-```
+### Local Development
+
+Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally:
+
+```bash
 npm i -g mint
 ```
 
 Run the following command at the root of your documentation, where your `docs.json` is located:
 
-```
+```bash
 mint dev
 ```
 
 View your local preview at `http://localhost:3000`.
 
-## Publishing changes
+### Publishing Changes
 
 Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
 
-## Need help?
+### Need Help?
 
-### Troubleshooting
+#### Troubleshooting
 
 - If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
 - If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
 
-### Resources
+#### Resources
 - [Mintlify documentation](https://mintlify.com/docs)
 - [Mintlify community](https://mintlify.com/community)
+- [Pangolin GitHub Repository](https://github.com/fosrl/pangolin)