Merge pull request #13 from 1Cor125/clean_up_readme

docs: simplify and clarify root README

Author: jjhafer

README.md

@@ -17,51 +17,10 @@ pooling, write serialization, and proper resource management.
    * **Optimized Connection Pooling**: Separate read and write pools for concurrent reads,
      even while writing
    * **Write Serialization**: Exclusive write access through connection manager
-   * **Migration Support**: Uses SQLx's database migration system
+   * **Migration Support**: Uses SQLx's database migration system (coming soon)
    * **Custom Configuration**: Configure read pool size and idle timeouts
    * **Type Safety**: Full TypeScript bindings
-   * **Resource Management**: Proper cleanup on application exit
-
-## Project Structure
-
-This project is organized as a Cargo workspace with the following structure:
-
-```text
-tauri-plugin-sqlite/
-├── crates/
-│   └── sqlx-sqlite-conn-mgr/   # SQLx SQLite connection manager
-│       ├── src/
-│       │   ├── config.rs       # Database configuration types
-│       │   ├── database.rs     # Core database wrapper
-│       │   ├── error.rs        # Error types
-│       │   ├── lib.rs          # Public API
-│       │   ├── registry.rs     # Database registry
-│       │   └── write_guard.rs  # Write access guard
-│       ├── Cargo.toml
-│       └── README.md
-├── src/                        # Tauri plugin implementation
-│   ├── commands.rs             # Plugin commands (Phase 2)
-│   ├── error.rs                # Error types
-│   └── lib.rs                  # Plugin initialization
-├── guest-js/                   # JavaScript/TypeScript API
-│   ├── index.ts                # Database class and types
-│   └── tsconfig.json
-├── permissions/                # Tauri permission definitions
-│   ├── autogenerated/          # Generated permission files
-│   ├── schemas/                # Permission schemas
-│   └── default.toml            # Default permission set
-├── dist-js/                    # Built JavaScript (generated)
-│   ├── index.js                # ESM build
-│   ├── index.cjs               # CommonJS build
-│   └── index.d.ts              # TypeScript declarations
-├── .github/                    # CI/CD workflows
-├── Cargo.toml                  # Workspace configuration
-├── package.json                # NPM package configuration
-├── rollup.config.js            # JavaScript build configuration
-├── api-iife.js                 # Browser IIFE bundle (generated)
-├── build.rs                    # Build script
-└── README.md                   # This file
-```
+   * **Resource Management**: Proper cleanup on application exit (coming soon)
 
 ## Crates
 
@@ -162,12 +121,6 @@ import Database from '@silvermine/tauri-plugin-sqlite'
 
 // Connect to a database (path is relative to app config directory)
 const db = await Database.load('mydb.db')
-
-// Or with custom connection configuration
-const db = await Database.load('mydb.db', {
-   maxReadConnections: 10,  // Default: 6
-   idleTimeoutSecs: 60      // Default: 30
-})
 ```
 
 > **Note:** Database paths are relative to the app's config directory. Unlike
@@ -386,19 +339,6 @@ const filtered = await db.fetchAll<User[]>(
 > **Note:** Use `execute()` and `executeTransaction()` for write operations.
 > For SELECT queries, use `fetchAll()` or `fetchOne()`.
 
-## Configuration
-
-### Connection Pool Options
-
-Configure the connection pool when loading a database:
-
-```typescript
-const db = await Database.load('mydb.db', {
-   maxReadConnections: 10,  // Max concurrent read connections (default: 6)
-   idleTimeoutSecs: 60      // Idle timeout in seconds (default: 30)
-})
-```
-
 ### Architecture
 
 The plugin uses `sqlx-sqlite-conn-mgr` for optimized connection management:
@@ -435,8 +375,8 @@ Connect to a database and return a Database instance.
 
 ```typescript
 const db = await Database.load('mydb.db', {
-   maxReadConnections: 10,
-   idleTimeoutSecs: 60
+   maxReadConnections: 10, // defaults to 6 if no config is provided
+   idleTimeoutSecs: 60     // defaults to 30 if no config is provided
 })
 ```
 
@@ -528,8 +468,8 @@ interface WriteQueryResult {
 }
 
 interface CustomConfig {
-   maxReadConnections?: number  // Default: 6
-   idleTimeoutSecs?: number     // Default: 30
+   maxReadConnections?: number
+   idleTimeoutSecs?: number
 }
 ```
 
@@ -614,7 +554,6 @@ With this setup, `tauri dev` shows all plugin and app logs, while `tauri build`
 a release binary that contains no logging from this plugin or your app-level `tracing`
 calls.
 
-
 ## Development Standards
 
 This project follows the