Update README.md

Author: albertodebortoli

README.md

@@ -1,3 +1,231 @@
 # ToggleGen
 
-A description of this package.
+[![Swift 6.0](https://img.shields.io/badge/Swift-6.0-orange.svg)](https://swift.org)
+[![Platform](https://img.shields.io/badge/platform-iOS%20%7C%20macOS-lightgrey.svg)](https://github.com/TogglesPlatform/ToggleGen)
+
+**ToggleGen** is a Swift command-line tool that generates type-safe Swift code for feature toggles (feature flags) from JSON configuration files. It creates strongly-typed accessor classes and variable enums to help you manage feature toggles in your iOS and macOS applications safely and efficiently.
+
+## Features
+
+- 🚀 **Type-Safe Code Generation**: Generates Swift enums and accessor classes with proper type safety
+- 📝 **Template-Based**: Uses Stencil templates for flexible code generation
+- 🔧 **Multiple Data Types**: Supports boolean, integer, double, string, secure, and object toggle types
+- 🎯 **Access Control**: Configurable access control levels (open, public, package, internal)
+- 🏗️ **Custom Property Names**: Supports custom property names through metadata
+- ⚡ **Command-Line Interface**: Easy-to-use CLI with comprehensive options
+
+## Supported Toggle Types
+
+ToggleGen supports the following toggle value types:
+
+- **Boolean** (`bool`): True/false values
+- **Integer** (`int`): Whole numbers
+- **Number** (`number`): Floating-point numbers
+- **String** (`string`): Text values
+- **Secure** (`secure`): Encrypted/encoded values
+- **Object** (`object`): Complex nested objects
+
+## Installation
+
+### Download Pre-built Binary
+
+Download the latest pre-built binary from [GitHub Releases](https://github.com/TogglesPlatform/ToggleGen/releases):
+
+```bash
+# Download and install (replace VERSION with the latest version)
+curl -L https://github.com/TogglesPlatform/ToggleGen/releases/download/VERSION/ToggleGen -o /usr/local/bin/ToggleGen
+chmod +x /usr/local/bin/ToggleGen
+```
+
+### Building from Source
+
+```bash
+git clone https://github.com/TogglesPlatform/ToggleGen.git
+cd ToggleGen
+swift build -c release
+```
+
+The executable will be available at `.build/release/ToggleGen`.
+
+## Usage
+
+### Basic Command
+
+```bash
+ToggleGen \
+  --datasource-path ./Demo/DemoDatasource.json \
+  --variables-template-path ./Templates/Variables.stencil \
+  --accessor-template-path ./Templates/Accessor.stencil \
+  --variables-enum-name "ToggleVariables" \
+  --accessor-class-name "ToggleAccessor" \
+  --variables-output-path ./GeneratedCode \
+  --accessor-output-path ./GeneratedCode
+```
+
+### With Access Control
+
+```bash
+ToggleGen \
+  --variables-template-path ./Templates/Variables.stencil \
+  --accessor-template-path ./Templates/Accessor.stencil \
+  --variables-enum-name "ToggleVariables" \
+  --accessor-class-name "ToggleAccessor" \
+  --datasource-path ./Demo/DemoDatasource.json \
+  --accessor-output-path ./GeneratedCode \
+  --variables-output-path ./GeneratedCode \
+  --variables-access-control public \
+  --accessor-access-control public
+```
+
+### Command Options
+
+| Option | Description | Required |
+|--------|-------------|----------|
+| `--variables-template-path` | Path to the variables template file | ✅ |
+| `--accessor-template-path` | Path to the accessor template file | ✅ |
+| `--variables-enum-name` | Name for the generated variables enum | ✅ |
+| `--accessor-class-name` | Name for the generated accessor class | ✅ |
+| `--datasource-path` | Path to the JSON datasource file | ✅ |
+| `--accessor-output-path` | Output directory for the accessor file | ✅ |
+| `--variables-output-path` | Output directory for the variables file | ✅ |
+| `--variables-access-control` | Access level for variables (open/public/package/internal) | ❌ |
+| `--accessor-access-control` | Access level for accessor (open/public/package/internal) | ❌ |
+
+## Configuration File Format
+
+Create a JSON file with your toggle configuration:
+
+```json
+{
+  "toggles": [
+    {
+      "variable": "enable_new_feature",
+      "bool": true
+    },
+    {
+      "variable": "max_retry_count",
+      "int": 3
+    },
+    {
+      "variable": "api_timeout",
+      "number": 30.0
+    },
+    {
+      "variable": "welcome_message",
+      "string": "Welcome to our app!"
+    },
+    {
+      "variable": "api_key",
+      "secure": "eDUxAQXW6dobqAMxhZIJLkyQKb8+36bFHc36eabacXDahMipVnGy/Q=="
+    },
+    {
+      "variable": "custom_toggle",
+      "bool": false,
+      "propertyName": "isCustomFeatureEnabled"
+    }
+  ]
+}
+```
+
+## Generated Code Example
+
+### Variables Enum (`ToggleVariables.swift`)
+
+```swift
+import Foundation
+
+public enum ToggleVariables {
+    public static let enableNewFeature = "enable_new_feature"
+    public static let maxRetryCount = "max_retry_count"
+    public static let apiTimeout = "api_timeout"
+    public static let welcomeMessage = "welcome_message"
+    public static let apiKey = "api_key"
+    public static let isCustomFeatureEnabled = "custom_toggle"
+}
+```
+
+### Accessor Class (`ToggleAccessor.swift`)
+
+```swift
+import Foundation
+import Toggles
+
+public class ToggleAccessor {
+    private(set) var manager: ToggleManager
+    
+    public init(manager: ToggleManager) {
+        self.manager = manager
+    }
+}
+
+extension ToggleAccessor {
+    public var enableNewFeature: Bool {
+        get { manager.value(for: ToggleVariables.enableNewFeature).boolValue! }
+    }
+    
+    public var maxRetryCount: Int {
+        get { manager.value(for: ToggleVariables.maxRetryCount).intValue! }
+    }
+    
+    public var apiTimeout: Double {
+        get { manager.value(for: ToggleVariables.apiTimeout).numberValue! }
+    }
+    
+    public var welcomeMessage: String {
+        get { manager.value(for: ToggleVariables.welcomeMessage).stringValue! }
+    }
+    
+    public var apiKey: String {
+        get { manager.value(for: ToggleVariables.apiKey).secureValue! }
+    }
+    
+    public var isCustomFeatureEnabled: Bool {
+        get { manager.value(for: ToggleVariables.isCustomFeatureEnabled).boolValue! }
+    }
+}
+```
+
+## Templates
+
+ToggleGen uses [Stencil](https://github.com/stencilproject/Stencil) templates for code generation. You can customize the generated code by modifying the template files:
+
+- **Variables Template**: Generates the enum with toggle variable names
+- **Accessor Template**: Generates the accessor class with type-safe properties
+
+Example templates are provided in the `Templates/` directory.
+
+## Integration with Toggles Framework
+
+The generated code is designed to work with a `ToggleManager` class that provides the actual toggle values at runtime. The generated accessor acts as a type-safe wrapper around your toggle management system.
+
+## Development
+
+### Running Tests
+
+```bash
+swift test
+```
+
+### Building
+
+```bash
+swift build
+```
+
+## Requirements
+
+- Swift 6.0 or later
+- iOS 15.0+ / macOS 12.0+
+
+## Dependencies
+
+- [Swift Argument Parser](https://github.com/apple/swift-argument-parser) - Command-line interface
+- [Stencil](https://github.com/stencilproject/Stencil) - Template engine
+
+## License
+
+This project is licensed under the terms specified in the [LICENSE](LICENSE) file.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.