Skip to content

Commit

Permalink
docs(readme): update installation instructions to lazy + added depend…
Browse files Browse the repository at this point in the history
…encies (#12)
  • Loading branch information
kiran94 committed May 28, 2023
1 parent df35782 commit 6145c83
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,21 @@
Take Screenshots directly from [Neovim](https://github.com/neovim/neovim) and embed references into markdown documents. This plugin relies on [maim](https://github.com/naelstrof/maim) being installed on your system.

## Usage
## Install

Using `lazy.nvim`:

```lua
use {'kiran94/maim.nvim', config = function() require('maim').setup() end }
{ 'kiran94/maim.nvim', config = true, cmd = {"Maim", "MaimMarkdown"} },
```

Once installed, you can check if the plugin is ready to work via `:checkhealth maim`. Note that if you take the lazy loaded approach, the plugin will likely needs to be loaded to check health.

### Dependencies

- Neovim 0.9+
- [maim](https://github.com/naelstrof/maim#install-using-your-package-manager-preferred)

## Commands

| Command | Description |
Expand Down

0 comments on commit 6145c83

Please sign in to comment.