diff --git a/README.md b/README.md index bf337d3..e62c76c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,22 @@ +
+

Experimental changes navigation plugin

+
+ +## ❓ What is this and why? + +Compass is an attempt to expand on the concept of `:h changelist` to allow: + +- Chronological navigation between changes located in different files. +- Persisting change marks between vim sessions. +- Providing optional visual feedback and other ergonomics. +- Using recorded changes akin to builtin `:h mark`. + +The end goal of the plugin is to improve codebase navigation in a way +that does not require proactive considerations on which location will be of interest later. + ## 🎯 Requirements @@ -21,11 +38,12 @@ "myypo/compass.nvim", build = "make", event = "BufReadPost", + opts = {}, } ``` The plugin uses [nvim-oxi](https://github.com/noib3/nvim-oxi) -to make it possible to use Rust instead of lua/vimscript. +to make it possible to use rust instead of lua/vimscript. The provided above installation snippet will download a pre-built by GitHub action library which should work out of the box, but you can also build it yourself, provided, you have Rust toolchain installed.