Skip to content

Commit b7f01ba

Browse files
committed
doc(readme): update documentation
1 parent 3237e53 commit b7f01ba

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
**:exclamation: NXWM is currently in *alpha* status, expect crashes/hangs and constant API change** \
2-
**:exclamation: NXWM is currently being rewritten to wayland, which when merged will break everything**
3-
# NXWM 0.0.1
4-
Neovim X11 Window Manager allows you to use x11 windows as if they were buffers.
1+
:exclamation: NXWM is currently being rewritten to **wayland**, which when merged will change most things
2+
# NXWM
3+
**N**eovim **X**11 **W**indow **M**anager allows you to use x11 windows as if they were buffers.
54
When entering a x-window-buffer, you'll need to start insert-mode to focus the x-window (unless some configurations are set to do this automatically).
65
## Requirements
76
+ `libx11`
@@ -12,18 +11,16 @@ When entering a x-window-buffer, you'll need to start insert-mode to focus the x
1211
+ NOTE: some terminals may support `TIOCGWINSZ` while still not working (like `neovim-qt`)
1312
## Installation
1413
Use whichever package manager you like.\
15-
It is recommended to lock/pin the plugin to one version because of API changes.
14+
It is recommended to lock/pin the plugin to one version/branch because of changes.
1615

17-
### you can install by
1816
- lazy
1917
```lua
20-
{"altermo/nxwm",},
18+
{'altermo/nxwm',branch='x11'},
2119
```
2220
- packer
2321
```lua
24-
use {"altermo/nxwm" },
22+
use {'altermo/nxwm',branch='x11'},
2523
```
26-
**:exclamation: please note that this will install version 0.0.1, as previsly setated that this is a work in progress**
2724

2825
## Configuration
2926
Using `require("nxwm").setup({})` is **not required**, it is only there if you want to change the default config.
@@ -49,7 +46,7 @@ Using `require("nxwm").setup({})` is **not required**, it is only there if you w
4946
end,
5047
--Whether to be more verbose
5148
verbal=false,
52-
--Map to unfocus a window
49+
--Map to unfocus a window (multiple key mappings is not (yet) supported)
5350
unfocus_map='<A-F4>',
5451
--Create your own mappings
5552
--IMPORTANT: the x-window needs to be focused for such mappings to work

0 commit comments

Comments
 (0)