Skip to content

Commit

Permalink
docs: update image
Browse files Browse the repository at this point in the history
  • Loading branch information
dimasriat committed Feb 7, 2024
1 parent bb6fbed commit 005d5dc
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# gecko.nvim 🦎

![gecko](gecko.png)
![gecko](gecko-nvim.gif)

<div align="center">

Expand Down Expand Up @@ -48,15 +48,27 @@ use {'dimasriat/gecko.nvim'}

## Usage

1. Open Neovim.
2. To use `gecko.nvim`, you can set up a keymap in your Neovim configuration. For example:
To start exploring cryptocurrency data directly within Neovim, you first need
to set up a keybinding for the `gecko:find_coin()` function. This will allow
you to invoke the Gecko plugin and search for coin details with ease.

```lua
local gecko = require("gecko")
vim.keymap.set('n', '<leader>zg', gecko.find_coin, {})
```
Here is a basic example of how to configure a keybinding:
```lua
local gecko = require("gecko")

-- Set up a keybinding to invoke the Gecko plugin
-- This binds the function to <leader>zg in normal mode
vim.keymap.set('n', '<leader>zg', function()
gecko:find_coin()
end, {desc = "Invoke Gecko to find coin details"})
```
In this configuration, pressing `<leader>zg` in normal mode will activate the
`gecko:find_coin()` function, allowing you to search and display cryptocurrency
information right within your Neovim editor.

3. Press `<leader>zg` in normal mode to invoke the plugin and start searching for cryptocurrencies.
Ensure you replace `<leader>zg` with your preferred keybinding if necessary. The
`<leader>` key is a placeholder that can be defined in Neovim to be any key you
choose, making your custom shortcuts comfortable and intuitive to use.

## Contributing

Expand Down
Binary file added gecko-nvim.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed gecko.png
Binary file not shown.

0 comments on commit 005d5dc

Please sign in to comment.