Move README.md to root directory and update documentation links

octoprint_tailscale_funnel/BUILDING.md

@@ -122,4 +122,25 @@ The plugin version is defined in `setup.py`. To release a new version:
 
 * [OctoPrint Plugin Development Documentation](https://docs.octoprint.org/en/master/plugins/getting-started.html)
 * [Tailscale Documentation](https://tailscale.com/kb/)
-* [Python Packaging Documentation](https://packaging.python.org/)
+* [Python Packaging Documentation](https://packaging.python.org/)
+
+## Project Structure
+
+The project follows a standard structure:
+
+```
+.
+├── README.md                    # Project overview and usage instructions
+├── .gitignore                   # Files and directories to exclude from Git
+├── octoprint_tailscale_funnel/  # Plugin source code
+│   ├── BUILDING.md              # This document
+│   ├── setup.py                 # Plugin setup and metadata
+│   ├── __init__.py              # Main plugin implementation
+│   ├── tailscale_interface.py   # Tailscale command interface
+│   ├── status_monitor.py        # Status monitoring functionality
+│   ├── requirements.txt         # Python dependencies
+│   ├── MANIFEST.in              # Files to include in distribution
+│   ├── static/                  # Static assets (CSS, JS)
+│   ├── templates/               # HTML templates
+│   └── tests/                   # Unit tests
+```

octoprint_tailscale_funnel/README.md

@@ -1,50 +0,0 @@
-# OctoPrint Tailscale Funnel Plugin
-
-This plugin makes your OctoPrint instance accessible from anywhere via Tailscale Funnel, without needing to configure port forwarding, dynamic DNS, or complex firewall settings.
-
-## Features
-
-* Enable/disable Tailscale Funnel access directly from OctoPrint's settings
-* Monitor the current Funnel connection status
-* Display the public URL for accessing OctoPrint remotely
-* Configure the port to expose via Funnel
-
-## Requirements
-
-* OctoPrint 1.3.0 or higher
-* Tailscale installed and configured on the system
-* Python 3.7 or higher
-
-## Installation
-
-1. Install Tailscale on your system and ensure it's running
-2. Install the plugin through OctoPrint's plugin manager
-3. Configure the plugin settings in OctoPrint's settings panel
-4. Enable Funnel through the plugin interface
-
-## Building from Source
-
-If you want to build the plugin from source, please refer to the [BUILDING.md](BUILDING.md) file for detailed instructions.
-
-## Configuration
-
-The plugin adds a new section to OctoPrint's settings panel with the following options:
-
-* **Port**: The port to expose via Funnel (default: 80)
-* **Confirm Enable**: Require confirmation before enabling Funnel (default: True)
-
-## Security Considerations
-
-Enabling Funnel makes your OctoPrint instance accessible from the public internet. Only enable it when needed and disable it when finished. The plugin will show a confirmation dialog before enabling Funnel if the "Confirm Enable" option is checked.
-
-## API Endpoints
-
-The plugin exposes the following API endpoints:
-
-* `GET /api/plugin/tailscale_funnel/status` - Get current Funnel status
-* `POST /api/plugin/tailscale_funnel/enable` - Enable Tailscale Funnel
-* `POST /api/plugin/tailscale_funnel/disable` - Disable Tailscale Funnel
-
-## License
-
-AGPLv3