Skip to content

Commit 6c3dc37

Browse files
authored
Update README.md
1 parent cfff21e commit 6c3dc37

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Codex Neovim Plugin
2+
<img width="1480" alt="image" src="https://github.com/user-attachments/assets/eac126c5-e71c-4de9-817a-bf4e8f2f6af9" />
23

3-
A Neovim plugin integrating the open-sourced Codex CLI (`codex`).
4+
## A Neovim plugin integrating the open-sourced Codex CLI (`codex`).
45
> Latest version: ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/johnseth97/codex.nvim?sort=semver)
56
6-
Features:
7+
### Features:
78
- ✅ Toggle Codex floating window with `:CodexToggle`
89
- ✅ Optional keymap mapping via `setup` call
910
- ✅ Background running when window hidden
1011
- ✅ Statusline integration via `require('codex').status()`
1112

12-
Installation:
13+
### Installation:
1314

1415
- Install the `codex` CLI via npm, or mark autoinstall as true in the config function
1516

@@ -48,10 +49,10 @@ return {
4849
}
4950
```
5051

51-
Usage:
52+
### Usage:
5253
- Call `:Codex` (or `:CodexToggle`) to open or close the Codex popup.
5354
-- Map your own keybindings via the `keymaps.toggle` setting.
54-
- Add lualinenotifier to show backgrounded Codex window:
55+
- Add the following code to show backgrounded Codex window in lualine:
5556
```lua
5657
require('codex').status() -- drop in to your lualine sections
5758
```

0 commit comments

Comments
 (0)