Made the README more user-friendly

Signed-off-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com>

Author: Skarlso

intellij-plugin/README.md

@@ -1,14 +1,6 @@
 # CRD to Sample YAML - IntelliJ Plugin
 
-IntelliJ IDEA plugin for generating sample YAML files from Kubernetes Custom Resource Definitions using the CTY tool.
-
-## Features
-
-- **CRD Detection**: Automatically detects CRD files in your project
-- **Sample Generation**: Generate complete, minimal, or commented sample YAML files
-- **Validation**: Validate sample YAML files against CRD schemas
-- **Context Menu Integration**: Right-click on CRD files to access all features
-- **Configurable**: Settings panel to configure CTY binary path and output options
+IntelliJ plugin for generating sample YAML files from Kubernetes Custom Resource Definitions.
 
 ## Prerequisites
 
@@ -19,101 +11,36 @@ go install github.com/Skarlso/crd-to-sample-yaml@latest
 
 ## Installation
 
-1. Build the plugin:
-   ```bash
-   cd intellij-plugin
-   ./gradlew buildPlugin
-   ```
+Build the plugin and install the ZIP from `build/distributions/`:
+```bash
+cd intellij-plugin
+./gradlew buildPlugin
+```
 
-2. Install the generated `.zip` file from `build/distributions/` via:
-   - **File → Settings → Plugins → Install Plugin from Disk**
+Install via File → Settings → Plugins → Install Plugin from Disk
 
 ## Usage
 
-### Generate Samples
-1. Right-click on any CRD YAML file
-2. Select **CRD to Sample YAML** from the context menu
-3. Choose your generation option:
-   - **Generate Sample YAML** - Complete sample with all fields
-   - **Generate Minimal Sample YAML** - Required fields only
-   - **Generate Sample YAML with Comments** - Sample with field descriptions
-
-### Validate Samples
-1. Right-click on a CRD file
-2. Select **CRD to Sample YAML → Validate Sample Against CRD**
-3. Choose the sample YAML file to validate
-
-### Configure Settings
-1. Go to **File → Settings → Tools → CRD to Sample YAML**
-2. Configure:
-   - **CTY Binary Path**: Path to the cty executable (leave empty to use PATH)
-   - **Output Location**: Where to save generated files
-   - **Show Notifications**: Enable/disable success/error notifications
+Right-click on CRD YAML files to access the `CRD to Sample YAML` menu. Generate complete, minimal, or commented samples. Validate existing samples against CRD schemas.
+
+Configure the CTY binary path and output location in File → Settings → Tools → CRD to Sample YAML.
 
 ## Development
 
-### Prerequisites
-- IntelliJ IDEA 2023.2+
-- Java 17+
-- Gradle
+Requires IntelliJ IDEA 2023.2+, Java 17+, and Gradle.
 
-### Setup
 ```bash
 git clone https://github.com/Skarlso/crd-to-sample-yaml.git
 cd crd-to-sample-yaml/intellij-plugin
-./gradlew buildPlugin
-```
-
-### Testing
-```bash
-./gradlew test
-```
-
-### Running in Development
-```bash
-./gradlew runIde
-```
-
-### Project Structure
-```
-src/main/java/com/skarlso/crdtosampleyaml/
-├── actions/               # Context menu actions
-│   ├── BaseAction.java
-│   ├── GenerateSampleAction.java
-│   ├── GenerateMinimalSampleAction.java
-│   ├── GenerateSampleWithCommentsAction.java
-│   └── ValidateSampleAction.java
-├── services/              # Core services
-│   ├── CrdDetectorService.java
-│   └── CtyService.java
-└── settings/              # Plugin configuration
-    ├── CtySettings.java
-    └── CtyConfigurable.java
+./gradlew buildPlugin  # Build
+./gradlew test         # Test
+./gradlew runIde       # Run in development
 ```
 
 ## Troubleshooting
 
-### CTY Not Found
-- Install CTY: `go install github.com/Skarlso/crd-to-sample-yaml@latest`
-- Or configure the full path in plugin settings
-
-### No Context Menu Options
-- Ensure you're right-clicking on a valid CRD YAML file
-- CRD files must have `kind: CustomResourceDefinition` and `apiVersion: apiextensions.k8s.io/v1`
-
-### Generation Fails
-- Check that CTY is properly installed: `cty version`
-- Verify the CRD file is valid
-- Check IntelliJ's Event Log for detailed error messages
-
-## Building for Distribution
-
-```bash
-./gradlew buildPlugin
-```
-
-The plugin ZIP file will be created in `build/distributions/`
+Install CTY if missing: `go install github.com/Skarlso/crd-to-sample-yaml@latest` or configure the full path in settings.
 
-## License
+Context menu only appears on valid CRD files with `kind: CustomResourceDefinition` and `apiVersion: apiextensions.k8s.io/v1`.
 
-This plugin is part of the CRD to Sample YAML project and follows the same license terms.
+Check IntelliJ's Event Log for error details.