add auto-sync for Ikonis features and implement documentation via README.md

README.md

@@ -0,0 +1,56 @@
+# Daggerheart - Ikonis
+
+A Foundry VTT module for the **Daggerheart** system that adds a customizable "Ikonis" personalized weapon system. 
+
+The Ikonis system allows weapons to be upgraded with "Augments" (Tech) that provide various bonuses, effects, and modifications, managed through a dedicated hardware interface on the weapon sheet.
+
+## Features
+
+### 🛠️ The Ikonis Hardware Tab
+Every weapon sheet now includes a dedicated **Ikonis** tab.
+- **Install Tech**: Drag and drop features or select from the pre-defined list.
+- **Bonded Features**: Link a specific "Bonded" feature to the weapon that follows the user.
+- **Dynamic Slot Scaling**: The number of available augment slots automatically scales based on the weapon's **Tier** (1-4).
+
+### ⚙️ Global Hardware Manager
+GMs can access the **Global Hardware Manager** in the module settings to:
+- Define the global pool of available Augments.
+- Set the cost, effect, and name of each augment.
+- Link augments to specific **Features** (items) for automated description and icon fetching.
+- Configure the default "Bonded" feature for all Ikonis weapons.
+
+### 📚 Integrated Compendium
+Includes an **Ikonis Features** compendium containing 10 ready-to-use augments and bond effects with custom icons and descriptions.
+
+### ⚖️ Per-Tier Configuration
+Fine-tune the balance of your game by setting exactly how many slots are provided at each tier (1, 2, 3, and 4) in the module settings.
+
+## Installation
+
+1. Open the Foundry VTT Setup screen.
+2. Go to the **Add-on Modules** tab.
+3. Click **Install Module**.
+4. Paste the following manifest URL:
+   `https://git.geeks.gay/cosmo/dh-ikonis/raw/branch/main/module.json`
+5. Click **Install**.
+
+## Usage
+
+1. **For GMs**:
+   - Go to **Configure Settings** > **Daggerheart - Ikonis**.
+   - Click **Open Augment Manager** to customize your global tech list.
+   - Adjust the **Slots per Tier** settings to match your desired power level.
+2. **For Players**:
+   - Open a Weapon sheet.
+   - Click the **Ikonis** tab (microchip icon).
+   - Use the **Install Tech** button to add augments from the global list.
+   - Drag and drop features from the compendium into the Ikonis tab to link them.
+
+## Credits
+
+- Developed for the Daggerheart community.
+- Built by Antigravity & Cosmo.
+- Icons from the Foundry VTT core library.
+
+---
+*This is an unofficial module for the Daggerheart system.*