chore: Add basic README.md

This commit is contained in:
Myzel394 2024-04-11 23:09:57 +02:00
parent 3b481818d8
commit 99b9d657bb
No known key found for this signature in database
GPG Key ID: DEC4AAB876F73185

35
README.md Normal file
View File

@ -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
```