Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kyren223 committed May 9, 2024
1 parent 9b9c0f0 commit 0235bbc
Showing 1 changed file with 40 additions and 8 deletions.
48 changes: 40 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,29 @@
<div align="center">

# 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)
<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)
Expand All @@ -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>
Expand All @@ -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
Expand All @@ -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>
Expand Down Expand Up @@ -108,6 +135,7 @@ map <C-S-N> :action TridentSelectNext<CR>
```

### My settings values

* Width - 800
* Height - 400
* Font Size - 30
Expand All @@ -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>
Expand All @@ -140,19 +169,22 @@ 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.
4. Create a pull request.
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

0 comments on commit 0235bbc

Please sign in to comment.