Skip to content

Commit 8980b6e

Browse files
authored
Update README.md
1 parent 6b97e9f commit 8980b6e

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!-- Badges (replace with actual badges) -->
44

55
[![Lua](https://img.shields.io/badge/Lua-blue.svg?style=flat-square&logo=lua)](https://www.lua.org)
6-
[![License](https://img.shields.io/github/license/magnusriga/markdown-shortcuts.nvim?style=flat-square)](LICENSE)
6+
[![License](https://img.shields.io/github/license/magnusriga/markdown-tools.nvim?style=flat-square)](LICENSE)
77

88
> Enhancing your Markdown editing experience in Neovim with intuitive shortcuts and commands.
99
@@ -22,7 +22,7 @@
2222
## ⚡️ Requirements
2323

2424
- Neovim >= 0.8.0
25-
- Optional: A picker plugin (`fzf`/`fzf.vim`, `telescope.nvim`, or `mini.pick`) for the template creation feature.
25+
- Optional: A picker plugin (`fzf-lua`, `telescope.nvim`, or `mini.pick`) for the template creation feature.
2626
- Optional: An external Markdown preview tool (like `glow`, `pandoc`, etc.) if using the `MarkdownPreview` command.
2727

2828
## 📦 Installation
@@ -35,16 +35,14 @@ Use your favorite plugin manager.
3535
{
3636
'magnusriga/markdown-tools.nvim',
3737
-- Optional dependencies for picker:
38+
-- dependencies = { 'folke/snacks.nvim' },
39+
-- dependencies = { 'ibhagwan/fzf-lua' },
3840
-- dependencies = { 'nvim-telescope/telescope.nvim' },
39-
-- dependencies = { 'junegunn/fzf', 'junegunn/fzf.vim' },
40-
-- dependencies = { 'echasnovski/mini.nvim' }, -- If using mini.pick
41-
event = "FileType markdown", -- Load when a markdown file is opened
42-
config = function()
43-
require('markdown-shortcuts').setup({
41+
opts = {
4442
-- Your custom configuration here
4543
-- Example: Use Telescope for template picking
4644
-- picker = 'telescope',
47-
})
45+
}
4846
end,
4947
}
5048
```
@@ -53,14 +51,14 @@ Use your favorite plugin manager.
5351

5452
```lua
5553
use {
56-
'magnusriga/markdown-shortcuts.nvim',
54+
'magnusriga/markdown-tools.nvim',
5755
-- Optional dependencies:
56+
-- requires = { 'folke/snacks.nvim' },
57+
-- requires = { 'ibhagwan/fzf-lua' },
5858
-- requires = { 'nvim-telescope/telescope.nvim' },
59-
-- requires = { 'junegunn/fzf', run = ':call fzf#install()' },
60-
-- requires = { 'echasnovski/mini.nvim' },
6159
ft = { "markdown" },
6260
config = function()
63-
require('markdown-shortcuts').setup({
61+
require('markdown-tools').setup({
6462
-- Configuration goes here
6563
})
6664
end,
@@ -73,7 +71,7 @@ Call the `setup` function to configure the plugin. Here are the default settings
7371

7472
```lua
7573
-- Default configuration
76-
require('markdown-shortcuts').setup({
74+
require('markdown-tools').setup({
7775
-- Directory containing your Markdown templates
7876
template_dir = vim.fn.expand("~/.config/nvim/templates"),
7977

0 commit comments

Comments
 (0)