summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKyren223 <ulmliad223@gmail.com>2024-02-22 22:34:10 +0200
committerKyren223 <ulmliad223@gmail.com>2024-02-22 22:34:10 +0200
commit02b1533ff4002f1015b9c26cf69256d821ddb6b1 (patch)
treea53ba1aed8abd703eb6c47164f1b5a553d3b09c0 /README.md
parent883fd7f58b2ef0254cb3c3fa79cc24f6dcdf9efd (diff)
Rebranded to "Trident"
Diffstat (limited to 'README.md')
-rw-r--r--README.md85
1 files changed, 45 insertions, 40 deletions
diff --git a/README.md b/README.md
index 7f2ba7f..b03fc1a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,9 @@
<div align="center">
-# Harpoon for JetBrains
-##### Getting you where you want with the fewest keystrokes.
+# Trident
+##### Effortless file traversal to minimize keystrokes and maximize productivity
+
+[![GitHub release](https://img.shields.io/github/v/release/Kyren223/Trident?style=for-the-badge)](https://github.com/Kyren223/Trident/releases/tag/1.0)
</div>
## Table of Contents
@@ -14,80 +16,83 @@
* [Contact](#contact)
## Description
-This plugin is inspired by the original [Harpoon](https://github.com/ThePrimeagen/harpoon) NeoVim plugin by ThePrimeagen
-but aims to provide the same functionality for JetBrains IDEs.
+Trident is a plugin for JetBrains IDEs that allows you to quickly navigate to your most used files with as few keystrokes as possible.
+
+The plugin is inspired by the [Harpoon](https://github.com/ThePrimeagen/harpoon) NeoVim plugin by ThePrimeagen but aims to add additional features and proper integration with the IDE.
## Features
* Navigate to your most used files with a single keystroke.
-* Easily append files to your Harpoon list.
+* Easily append files to a per-project list for fast access.
* Quick Menu
- * Select a file from your Harpoon list and open it.
- * Delete a file from your Harpoon list.
- * Reorder / Move files in your Harpoon list.
- * Add / Insert files to your Harpoon list.
+ * Select a file from the list and open it.
+ * Delete a file from the list.
+ * Reorder / Move files in the list.
+ * Add / Insert files to the list.
* Project-relative file paths using `...` syntax.
-* Per-project Harpoon lists.
-* Configurable Vim & IDE keymaps for all actions.
+* Per-project lists.
+* Configurable IdeaVim and IDE keymaps for all actions.
## Installation
* Version 2023.1 or later of any IntelliJ-based IDE is required.
-* Install the plugin from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23771-harpoonforjb).
+* Install the plugin from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23771-trident).
## Getting Started
+* All actions can be mapped to IDE keymaps like usual, the examples below are for IdeaVim only.
+* Make sure to download IdeaVim if you want to configure the keymaps via .ideavimrc
### Example .ideavimrc Configuration
```vimrc
-" Append the current file to the Harpoon list
-map <leader>a :action HarpoonAppend<CR>
+" Append the current file to the list
+map <leader>a :action TridentAppend<CR>
-" Open the Harpoon quick menu
-map <C-h> :action HarpoonToggleQuickMenu<CR>
+" Open the quick menu
+map <C-h> :action TridentToggleQuickMenu<CR>
" Select the given file (from the Quick Menu) and open it
-map <leader>o :action HarpoonQuickMenuSelect<CR>
+map <leader>o :action TridentQuickMenuSelect<CR>
-" Hotkeys to open the first 4 items in the Harpoon list
-map <C-h> :action HarpoonSelect1<CR>
-map <C-t> :action HarpoonSelect2<CR>
-map <C-n> :action HarpoonSelect3<CR>
-map <C-s> :action HarpoonSelect4<CR>
+" Hotkeys to open the first 4 items in the list
+map <C-h> :action TridentSelect1<CR>
+map <C-t> :action TridentSelect2<CR>
+map <C-n> :action TridentSelect3<CR>
+map <C-s> :action TridentSelect4<CR>
-" Toggle previous & next buffers stored within Harpoon list
-map <C-S-P> :action HarpoonSelectPrev<CR>
-map <C-S-N> :action HarpoonSelectNext<CR>
+" Toggle previous & next buffers stored within the list
+map <C-S-P> :action TridentSelectPrev<CR>
+map <C-S-N> :action TridentSelectNext<CR>
```
### My .ideavimrc Configuration
```vimrc
-map <leader>a :action HarpoonAppend<CR>
-map <C-e> :action HarpoonToggleQuickMenu<CR>
+map <leader>a :action TridentAppend<CR>
+map <C-e> :action TridentToggleQuickMenu<CR>
" I am Using "Enter" from settings so no need to map it here
-map <C-1> :action HarpoonSelect1<CR>
-map <C-2> :action HarpoonSelect2<CR>
-map <C-3> :action HarpoonSelect3<CR>
-map <C-4> :action HarpoonSelect4<CR>
+map <C-1> :action TridentSelect1<CR>
+map <C-2> :action TridentSelect2<CR>
+map <C-3> :action TridentSelect3<CR>
+map <C-4> :action TridentSelect4<CR>
```
### Settings
**Descriptions**
-* Harpoon Width - Describes how wide the Harpoon Quick Menu should be.
-* Harpoon Height - Describes how tall the Harpoon Quick Menu
-* Harpoon Font Size - Describes the font size of the Harpoon Quick Menu
-* Enter - When checked the Harpoon Quick Menu will open the file when you press enter, otherwise it will look for your .ideavimrc file for the keybinding.
+* Width - Describes how wide the Quick Menu should be.
+* Height - Describes how tall the Quick Menu
+* Font Size - Describes the font size of the Quick Menu
+* Enter to select - When checked the Quick Menu will open the file when you press enter, otherwise it will look for your .ideavimrc file for the keybinding.
**Defaults**
-* Harpoon Width - 800
-* Harpoon Height - 400
-* Harpoon Font Size - 20
-* Enter - true
+* Width - 800
+* Height - 400
+* Font Size - 20
+* Enter to select - true
## Contribution
This plugin is open-source and contributions are welcome.
-Note to beginners or first-time contributors: I recommend starting by going to the issues tab and looking for issues to work on.
+I recommend looking at the issues tab or the [TODO.md](TODO.md) file for ideas on what to work on.
### Steps to contribute
1. Fork the repository.