Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
y0ung3r committed Nov 22, 2023
1 parent 824e1aa commit ef94eb7
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 6 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,27 @@
<!-- Plugin description -->
Intellij plugin to enable or disable global Git hooks

![Git Global Hooks Locator](src/main/resources/description.png)
Hooks are programs you can place in a hooks directory (specified in core.hooksPath) to trigger actions at certain points in git’s execution.
Unfortunately, Intellij can only keep track of local hooks located inside a project.
With this plugin, you can enable or disable your global Git hooks directly from the IDE.
The following hooks are available:
- pre-commit
- prepare-commit-msg
- commit-msg
- post-commit
- applypatch-msg
- pre-applypatch
- post-applypatch
- pre-rebase
- post-rewrite
- post-checkout
- post-merge
- pre-push
- pre-auto-gc
<!-- Plugin description end -->

![Git Global Hooks Locator](src/main/resources/description.png)

## Installation

- Using the IDE built-in plugin system:
Expand Down
6 changes: 1 addition & 5 deletions src/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@
<name>Git Global Hooks Locator</name>
<vendor>y0ung3r</vendor>

<description><![CDATA[
Intellij plugin to enable or disable global Git hooks
]]></description>

<change-notes><![CDATA[
Initial release
]]>
Expand All @@ -18,6 +14,6 @@
<resource-bundle>messages.LocatorBundle</resource-bundle>

<extensions defaultExtensionNs="com.intellij">
<toolWindow factoryClass="com.github.y0ung3r.gitglobalhookslocator.ui.toolWindow.GitGlobalHooksLocatorWindowFactory" id="GIt Global Hooks Locator" icon="AllIcons.General.Locate" />
<toolWindow factoryClass="com.github.y0ung3r.gitglobalhookslocator.ui.toolWindow.GitGlobalHooksLocatorWindowFactory" id="Git Global Hooks Locator" icon="AllIcons.General.Locate" />
</extensions>
</idea-plugin>

0 comments on commit ef94eb7

Please sign in to comment.