Skip to content

Commit a98670c

Browse files
authored
Merge pull request #65 from comod/doc_fixes
Improve documentation and update github workflow.
2 parents 63dce46 + 2fd4bd1 commit a98670c

3 files changed

Lines changed: 13 additions & 3 deletions

File tree

.github/workflows/build.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ name: Build IntelliJ Plugin with JBR 21
33

44
on:
55
push:
6-
branches: [ main ]
6+
branches: [ master ]
77
pull_request:
8-
branches: [ main ]
8+
branches: [ master ]
99
workflow_dispatch:
1010

1111
jobs:
@@ -28,7 +28,7 @@ jobs:
2828
run: $JAVA_HOME/bin/java -version
2929

3030
- name: Validate Gradle Wrapper
31-
uses: gradle/wrapper-validation-action@v2
31+
uses: gradle/actions/wrapper-validation@v3
3232

3333
- name: Set up Gradle
3434
uses: gradle/actions/setup-gradle@v4

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@ displayed as a:
1818
- Custom "scope" that can be used for example when searching and finally as a
1919
- Status bar widget
2020

21+
### Plugin Basics
22+
23+
The plugin will add a new tool window named **Git Scope**:
24+
25+
![](docs/tool_window.png)
26+
27+
By default, it will appear as a secondary tool window on the left side, but you can move it anywhere to suit your
28+
workflow. All features of this plugin are managed through the Git Scope tool window — no additional settings or
29+
preferences are added. In other words; the plugin extends the GUI of the Jetbrains IDE.
30+
2131
### Plugin Features
2232

2333
![](docs/icon.svg) **New Scope:**

docs/tool_window.png

21.9 KB
Loading

0 commit comments

Comments
 (0)