update readme

Author: t-book

README.md

@@ -1,3 +1,95 @@
+# KGR Toolbox
+
+A QGIS plugin for managing PostgreSQL database templates and creating portable project archives.
+
+## Features
+
+### 🗄️ PostgreSQL Template Management
+- **Create Templates**: Generate database templates from existing PostgreSQL databases without data
+- **Deploy Templates**: Create new databases from existing templates
+- **Schema Preservation**: Maintain all database structure, constraints, and relationships
+
+### 📦 Portable Project Archives
+- **PostgreSQL to Geopackage**: Convert all PostgreSQL layers to a single portable geopackage
+- **Complete Project Export**: Copy all project files including DCIM folders and media
+- **QField Compatible**: Create archives ready for mobile data collection with QField
+- **Progress Tracking**: Real-time progress feedback during export process
+
+## Installation
+
+### From QGIS Plugin Repository
+1. Open QGIS
+2. Go to `Plugins` → `Manage and Install Plugins`
+3. Search for "KGR Toolbox"
+4. Click `Install Plugin`
+
+### Manual Installation
+1. Download the latest release from [GitHub Releases](https://github.com/csgis/postgresql-template-manager/releases)
+2. Extract the zip file to your QGIS plugins directory:
+   - **Windows**: `C:\Users\[username]\AppData\Roaming\QGIS\QGIS3\profiles\default\python\plugins\`
+   - **macOS**: `~/Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins/`
+   - **Linux**: `~/.local/share/QGIS/QGIS3/profiles/default/python/plugins/`
+3. Restart QGIS
+4. Enable the plugin in `Plugins` → `Manage and Install Plugins` → `Installed`
+
+## Usage
+
+### PostgreSQL Template Management
+
+#### Creating a Template
+1. Open the KGR Toolbox plugin
+2. Go to the **Database Connection** tab
+3. Enter your PostgreSQL connection details
+4. Click **Test Connection**
+5. Switch to the **Create Template** tab
+6. Select source database and enter template name
+7. Click **Create Template**
+
+#### Deploying from Template
+1. Ensure your connection is configured
+2. Go to the **Deploy Template** tab
+3. Select the template database
+4. Enter new database name
+5. Click **Deploy Database**
+
+### Creating Portable Archives
+
+#### Export Project Archive
+1. Open your QGIS project with PostgreSQL layers
+2. Open the KGR Toolbox plugin
+3. Go to the **Archive Project** tab
+4. Select output folder
+5. Click **Create Portable Archive**
+
+The plugin will:
+- Copy all project files and folders (including DCIM)
+- Convert all PostgreSQL layers to a single geopackage
+- Update the project file to use geopackage sources
+- Create a portable `_portable.qgs` file
+
+#### Warning
+The archive process copies ALL files from your project directory, including DCIM folders which may be quite large. Choose your output location carefully.
+
+## Requirements
+
+- QGIS 3.0 or higher
+- PostgreSQL database with appropriate permissions
+- Python 3.6+ (included with QGIS)
+
+## Supported Formats
+
+### Input
+- PostgreSQL databases
+- QGIS projects (.qgs files)
+- All standard QGIS vector layers
+
+### Output
+- PostgreSQL templates
+- Geopackage (.gpkg)
+- Portable QGIS projects
+
+## Technical Details
+
 ### SQL Commands for Template Creation
 
 When creating a clean template from a database, the plugin executes the following SQL commands in sequence:
@@ -88,4 +180,58 @@ ORDER BY schemaname, tablename;
 
 # 5. Truncate each table (repeat for each table found)
 TRUNCATE TABLE "schema_name"."table_name" CASCADE;
-```
+```
+
+## Use Cases
+
+### Template Management
+- **Development Workflows**: Create clean database templates for new projects
+- **Testing**: Deploy consistent test databases
+- **Team Collaboration**: Share database structures without sensitive data
+- **Backup & Recovery**: Maintain structural backups
+
+### Portable Archives
+- **Project Sharing**: Share projects without database dependencies
+- **Offline Work**: Convert online projects for offline use
+- **Data Distribution**: Package projects for easy distribution
+
+
+## Troubleshooting
+
+### Common Issues
+
+**Connection Failed**
+- Verify PostgreSQL server is running
+- Check host, port, and credentials
+- Ensure user has appropriate permissions
+
+**Template Creation Failed**
+- Ensure user has CREATEDB privileges
+- Check database name doesn't already exist
+- Verify sufficient disk space
+
+**Archive Export Failed**
+- Check write permissions in output folder
+- Ensure sufficient disk space
+- Verify QGIS project is saved
+
+### Getting Help
+- Check the [Issues](https://github.com/csgis/kgr_toolbox/issues) page
+- Create a new issue with detailed description
+- Include QGIS version, PostgreSQL version, and error messages
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](https://opensource.org/license/mit) file for details.
+
+
+## Changelog
+
+### v1.0.0
+- Initial release
+- PostgreSQL template management
+- Portable project archive creation
+- QField compatibility
+- Progress tracking and user feedback
+
+---