diff --git a/README.md b/README.md new file mode 100644 index 0000000..d2e7254 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# jsonfly + +Fly through your JSON files with ease. +Search ✨ blazingly fast ✨ for keys via [Telescope](https://github.com/nvim-telescope/telescope.nvim), and navigate through your JSON structure with ease. + +## Installation + +Install with your favorite plugin manager, for example with [lazy.nvim](https://github.com/folke/lazy.nvim): + +```lua +{ + "nvim-telescope/telescope.nvim", + dependencies = { + -- "Myzel394/telescope-last-positions", + -- Other dependencies + -- .. + "Myzel394/jsonfly", + }, +}, +``` + +Load the extension with: + +```lua +require("telescope").load_extension("jsonfly") +``` + +## Usage + +Go to a JSON file and run: + +```lua +:Telescope jsonfly +``` +