diff options
| author | Kyren223 <ulmliad223@gmail.com> | 2024-05-09 19:07:04 +0300 |
|---|---|---|
| committer | Kyren223 <ulmliad223@gmail.com> | 2024-05-09 19:07:04 +0300 |
| commit | 0235bbcdf350d11aeae01a8ff60a2046164e9885 (patch) | |
| tree | b6b261d2755328c4291f134abc557bc169e64f63 | |
| parent | 9b9c0f0594209b8c4ecdb7901293734ccf567437 (diff) | |
Updated README.md
| -rw-r--r-- | README.md | 48 |
1 files changed, 40 insertions, 8 deletions
@@ -1,12 +1,29 @@ <div align="center"> # Trident + ##### Effortless file traversal to minimize keystrokes and maximize productivity -[](https://github.com/Kyren223/Trident/releases/tag/2.0.0) +<a href="https://plugins.jetbrains.com/plugin/23818-trident" alt="JetBrains Plugin Downloads"> + <img alt="JetBrains Plugin Downloads" src="https://img.shields.io/jetbrains/plugin/d/23818-trident?style=for-the-badge"> +</a> + +<a href="https://plugins.jetbrains.com/plugin/23818-trident/versions" alt="JetBrains Plugin Version"> + <img alt="JetBrains Plugin Version" src="https://img.shields.io/jetbrains/plugin/v/23818-trident?style=for-the-badge"> +</a> + +<a href="https://plugins.jetbrains.com/plugin/23818-trident/reviews" alt="JetBrains Plugin Rating"> + <img alt="JetBrains Plugin Rating" src="https://img.shields.io/jetbrains/plugin/r/stars/23818-trident?style=for-the-badge&link=https%3A%2F%2Fplugins.jetbrains.com%2Fplugin%2F23818-trident%2Freviews"> +</a> + +<a href="https://github.com/Kyren223/Trident/releases" alt="GitHub Release"> + <img alt="GitHub Release" src="https://img.shields.io/github/v/release/Kyren223/Trident?sort=semver&style=for-the-badge"> +</a> + </div> ## Table of Contents + * [Features](#features) * [Installation](#installation) * [Getting Started](#getting-started) @@ -16,35 +33,42 @@ * [Contact](#contact) ## Description -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. +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 a per-project list for fast access. * Quick Menu - * 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. + * 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 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 through the IDE's plugin manager by searching for "Trident". * Install the plugin from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23818-trident). * Install the plugin from the [GitHub Releases](https://github.com/Kyren223/Trident/releases). ## Getting Started + * The default settings are sensible, but you can customize them if you wish. * Actions can be mapped to IDE keymaps, search for "Trident" in the IDE's keymap settings. * If you are using IdeaVim, you can configure the keymaps through .ideavimrc ### Example .ideavimrc Configuration + ```vimrc " Append the current file to the list map <leader>a :action TridentAppend<cr> @@ -70,6 +94,7 @@ map <C-S-N> :action TridentSelectNext<CR> ## Configuration ### Settings + * Search for "Trident Settings" in the IDE's settings * You can customize the width, height, font size of the Trident list * You can also customize other settings, each setting has an explanation under it @@ -78,7 +103,9 @@ map <C-S-N> :action TridentSelectNext<CR> * Keymaps can also be configured through .ideavimrc (requires IdeaVim) ### Full .ideavimrc Configuration with all keymaps + * The comments explain the keymaps and their functionality + ```vimrc " Append the current file to the list map <leader>a :action TridentAppend<cr> @@ -108,6 +135,7 @@ map <C-S-N> :action TridentSelectNext<CR> ``` ### My settings values + * Width - 800 * Height - 400 * Font Size - 30 @@ -119,6 +147,7 @@ map <C-S-N> :action TridentSelectNext<CR> * Index Cycling - true ### My .ideavimrc Configuration + ```vimrc map <leader>a :action TridentAppend<cr> map <C-e> :action TridentToggleQuickMenu<cr> @@ -140,6 +169,7 @@ If you are looking for what to work on, see the [issues tab](https://github.com/ It's recommended to first open an issue before starting to work on a feature. ### Steps to contribute + 1. Fork the repository. 2. Make your changes and commit them. 3. Push your changes to your fork. @@ -147,12 +177,14 @@ It's recommended to first open an issue before starting to work on a feature. 5. Wait for the pull request to be reviewed and merged. ## License + This project is licensed under the MIT License, see the [LICENSE](LICENSE) file for details. The logo was designed by me and is copyrighted. You may not use it without my permission. ## Contact + * [GitHub](https://github.com/Kyren223) * Kyren223 on Discord |
