Skip to content

Commit 866f7d0

Browse files
committed
docs: notes on incompatibility with neovim
1 parent 7e42ba8 commit 866f7d0

File tree

3 files changed

+19
-7
lines changed

3 files changed

+19
-7
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Change Log
22

3+
## v1.2.4 (07-03-2024)
4+
**Added**
5+
Notes on incompatibility with Neovim
6+
37
## v1.2.0 (07-03-2024)
48

59
**Changed**

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Keymaps for [Vim](https://marketplace.visualstudio.com/items?itemName=vscodevim.
1212

1313
## 1.0 Installation
1414

15-
Install LunarKeymap via [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=fathulfahmy.lunarkeymap)
15+
Install LunarKeymap via [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=fathulfahmy.lunarkeymap).
1616

1717
## 2.0 Usage
1818

@@ -178,20 +178,27 @@ Full list of shortcuts are available on `Feature Contributions`.
178178

179179
8. Save user settings `ctrl+s`
180180

181-
<!-- ## Known Issues -->
181+
## 5.0 Known Issues
182182

183-
## 5.0 Contributing
183+
### Integration with Neovim
184+
185+
This extension does not support vscode/vim neovim mode or any other neovim extension.
186+
Configuration to both VS Code and user's Neovim is required in order for Neovim to work.
187+
VS Code extensions do not have access to user's application (Neovim).
188+
Follow Chris Chiarulli's tutorial on [how to embed Neovim in VS Code](https://www.youtube.com/watch?v=g4dXZ0RQWdw).
189+
190+
## 6.0 Contributing
184191

185192
1. Go to LunarKeymap [GitHub repository](https://github.com/fathulfahmy/lunarkeymap).
186193
2. Open [package.json](https://github.com/fathulfahmy/lunarkeymap/blob/main/package.json).
187194
3. Add JSON object to [contributes.configurationDefaults](https://github.com/fathulfahmy/lunarkeymap/blob/main/package.json) or [contributes.keybindings](https://github.com/fathulfahmy/lunarkeymap/blob/main/package.json).
188195
4. Open a pull request.
189196

190-
## 6.0 License
197+
## 7.0 License
191198

192-
This extension is licensed under the [MIT License](https://github.com/fathulfahmy/lunarkeymap/blob/main/LICENSE)
199+
This extension is licensed under the [MIT License](https://github.com/fathulfahmy/lunarkeymap/blob/main/LICENSE).
193200

194-
## 7.0 Special thanks
201+
## 8.0 Special thanks
195202

196203
- [LunarVim](https://github.com/LunarVim/LunarVim/tree/4625145d0278d4a039e55c433af9916d93e7846a/utils/vscode_config)
197204
- [Christian Chiarulli](https://www.youtube.com/watch?v=g4dXZ0RQWdw)

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"Other"
2323
],
2424
"keywords": [
25-
"lunar",
25+
"keybindings",
2626
"keymap",
2727
"vim",
2828
"lunarkeymap",
@@ -36,6 +36,7 @@
3636
"bugs": {
3737
"url": "https://github.com/fathulfahmy/lunarkeymap/issues"
3838
},
39+
"pricing": "Free",
3940
"contributes": {
4041
"configurationDefaults": {
4142
"vim.useSystemClipboard": true,

0 commit comments

Comments
 (0)