diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5df3298..c7947ee 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,6 +1,8 @@
# Changelog
+## v1.0.1
+- Fixed documentation and build script
+
## v1.0.0
- Traffic light buttons (red/yellow/green)
- Configurable button placement (left or right)
-
diff --git a/README.md b/README.md
index 5b3e824..f8e9f89 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,7 @@
+ 
@@ -22,33 +23,35 @@
📦 Install from JetBrains Marketplace 📦
-
# Table of Contents
- [Screenshot](#screenshot)
- [Features](#features)
- [Installation](#installation)
+ - [From Marketplace](#from-marketplace)
+ - [From Plugin ZIP](#from-plugin-zip)
+- [Getting Started](#getting-started)
- [Settings](#settings)
- [Build](#build)
- [License](#license)
- [Support](#support)
-
# Screenshot
-
# Features
-- LINUX ONLY (macOS already has native traffic lights; Windows support planned for a future release)
-- macOS-style traffic light buttons (red/yellow/green)
-- Four button states: active, hover (with action icons), pressed, and inactive (gray)
-- Configurable button placement (left or right side of the title bar)
-- Compatible with all JetBrains IDEs (2025.3.3+)
-
+| Feature | Description |
+|-----------------------|---------------------------------------------------------------------------------|
+| Traffic Light Buttons | macOS-style colored circles (red/yellow/green) replacing default window buttons |
+| Button States | Four states: active, hover (with action icons), pressed, and inactive (gray) |
+| Button Placement | Configurable left or right side of the title bar |
+| Button Order | IDE Default or macOS Style order (right placement only) |
+| Platform | Linux only (macOS already has native traffic lights; Windows support planned) |
+| Compatibility | All JetBrains IDEs (2025.3.3+) |
# Installation
@@ -58,13 +61,24 @@
2. Search for **Traffic Light Buttons**
3. Click **Install** and restart the IDE
-
## From Plugin ZIP
-1. Download the latest `TrafficLightButtons-*.zip` from [Releases](https://github.com/ddc/JetbrainsTrafficLightButtons/releases)
+1. Download the latest
+ `TrafficLightButtons-*.zip` from [Releases](https://github.com/ddc/JetbrainsTrafficLightButtons/releases)
2. Go to **Settings > Plugins > Install Plugin from Disk...**
3. Select the downloaded `.zip` file and restart the IDE
+# Getting Started
+
+After install and restart, the traffic light buttons are applied automatically with the default settings (right placement, IDE default order).
+To customize, go to:
+
+| Setting | How to change |
+|----------------------|-----------------------------------------------------------------------------------------------|
+| **Button Placement** | **Settings > Appearance & Behavior > Traffic Light Buttons** > select LEFT/RIGHT |
+| **Button Order** | **Settings > Appearance & Behavior > Traffic Light Buttons** > select IDE Default/macOS Style |
+
+> **Note:** Changes require an IDE restart to take effect. A restart dialog will appear after applying.
# Settings
@@ -72,21 +86,26 @@
- **Button Placement** — Left or Right (default: Right)
- **Button Order** — IDE Default or macOS Style (only available for Right placement)
- - **IDE Default**: Minimize, Maximize, Close
- - **macOS Style**: Maximize, Minimize, Close
-
+ - **IDE Default**: Minimize, Maximize, Close
+ - **macOS Style**: Maximize, Minimize, Close
# Build
+Requires JDK 21.
+
```bash
-./build.sh
+./build.sh # build only
+./build.sh [-v|--verify] # build with plugin verification
```
+The script formats Kotlin sources (if `ktlint` is available) and builds `TrafficLightButtons-.zip` inside the
+`build/` directory.
+Plugin settings and variables are configured at the top of `build.sh`.
+
# License
This project is licensed under the [Apache 2.0 License](LICENSE).
-
# Support
If you find this project helpful, consider supporting development.
diff --git a/build.sh b/build.sh
index 81134af..72559ec 100755
--- a/build.sh
+++ b/build.sh
@@ -3,13 +3,15 @@
# Automated script to build the plugin and register changes on the changelog file
# DDC Softwares (daniel@ddcsoftwares.com)
# https://github.com/ddc/JetbrainsTrafficLightButtons
+# Usage: ./build.sh [-v|--verify]
+# -v, --verify Run plugin verification before building
# ============================================================================
set -euo pipefail
# ============================================================================
# Variables
# ============================================================================
-PLUGIN_VERSION="1.0.0"
+PLUGIN_VERSION="1.0.1"
GRADLE_VERSION="9.4.0"
KOTLIN_VERSION="2.1.0"
INTELLIJ_PLATFORM_VERSION="2.12.0"
@@ -20,12 +22,17 @@ OUTPUT_FILENAME="TrafficLightButtons-${PLUGIN_VERSION}.zip"
# ============================================================================
WHATS_NEW=$(cat <<'EOF'
-- Traffic light buttons (red/yellow/green)
-- Configurable button placement (left or right)
+- Fixed documentation and build script
EOF
)
# ============================================================================
+RUN_VERIFY=false
+for arg in "$@"; do
+ case "$arg" in
+ -v|--verify) RUN_VERIFY=true ;;
+ esac
+done
pushd "$(dirname "${BASH_SOURCE[0]}")" > /dev/null
export JAVA_HOME
# ============================================================================
@@ -88,6 +95,7 @@ verify_plugin() {
build_plugin() {
log_action "Building plugin..."
+ rm -f "build/${OUTPUT_FILENAME}"
./gradlew buildPlugin -q
}
@@ -107,7 +115,7 @@ cleanup_build() {
write_gradle_properties
update_changelog
format_kotlin
-verify_plugin
+[[ "$RUN_VERIFY" == true ]] && verify_plugin
build_plugin
cleanup_build
diff --git a/gradle.properties b/gradle.properties
index b5f1c2b..0d61687 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -1,5 +1,5 @@
pluginName = Traffic Light Buttons
-pluginVersion = 1.0.0
+pluginVersion = 1.0.1
pluginSinceBuild = 253
platformVersion = 2025.3.3
pluginGroup = com.ddc.trafficlightbuttons
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
index a3802ba..00e426f 100644
--- a/src/main/resources/META-INF/plugin.xml
+++ b/src/main/resources/META-INF/plugin.xml
@@ -14,8 +14,9 @@
macOS-style traffic light buttons (red/yellow/green)
Hover icons (X, minus, fullscreen arrows)
Configurable button placement (left or right)
+ Windows support planned
-
+
Settings
Settings > Appearance & Behavior > Traffic Light Buttons
]]>