diff --git a/README.md b/README.md index 391f180..b486bed 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,29 @@
# 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/2.0.0) + + JetBrains Plugin Downloads + + + + JetBrains Plugin Version + + + + JetBrains Plugin Rating + + + + GitHub Release + +
## 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 a :action TridentAppend @@ -70,6 +94,7 @@ map :action TridentSelectNext ## 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 :action TridentSelectNext * 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 a :action TridentAppend @@ -108,6 +135,7 @@ map :action TridentSelectNext ``` ### My settings values + * Width - 800 * Height - 400 * Font Size - 30 @@ -119,6 +147,7 @@ map :action TridentSelectNext * Index Cycling - true ### My .ideavimrc Configuration + ```vimrc map a :action TridentAppend map :action TridentToggleQuickMenu @@ -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