Skip to content

Commit 153a977

Browse files
committed
docs: standardize README.md format
- Add Discussions badge for better discoverability - Remove redundant Table of Contents section - Move Version section into Requirements for cleaner organization - Add Quick Start section with code examples - Improve general layout and organization 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 9b8f3dd commit 153a977

1 file changed

Lines changed: 17 additions & 19 deletions

File tree

README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
[![Neovim Version](https://img.shields.io/badge/Neovim-0.7%2B-blueviolet?style=flat-square&logo=neovim)](https://github.com/neovim/neovim)
1010
[![Tests](https://img.shields.io/badge/Tests-44%20passing-success?style=flat-square&logo=github-actions)](https://github.com/greggh/claude-code.nvim/actions/workflows/ci.yml)
1111
[![Version](https://img.shields.io/badge/Version-0.4.2-blue?style=flat-square)](https://github.com/greggh/claude-code.nvim/releases/tag/v0.4.2)
12+
[![Discussions](https://img.shields.io/github/discussions/greggh/claude-code.nvim?style=flat-square&logo=github)](https://github.com/greggh/claude-code.nvim/discussions)
1213

1314
*A seamless integration between [Claude Code](https://github.com/anthropics/claude-code) AI assistant and Neovim*
1415

@@ -26,22 +27,6 @@
2627

2728
This plugin was built entirely with Claude Code in a Neovim terminal, and then inside itself using Claude Code for everything!
2829

29-
## Table of Contents
30-
31-
- [Features](#features)
32-
- [Requirements](#requirements)
33-
- [Installation](#installation)
34-
- [Configuration](#configuration)
35-
- [Usage](#usage)
36-
- [Commands](#commands)
37-
- [Key Mappings](#key-mappings)
38-
- [How it Works](#how-it-works)
39-
- [Contributing](#contributing)
40-
- [License](#license)
41-
- [Development](#development)
42-
- [Community](#community)
43-
- [Acknowledgements](#acknowledgements)
44-
4530
## Features
4631

4732
- 🚀 Toggle Claude Code in a terminal window with a single key press
@@ -61,9 +46,7 @@ This plugin was built entirely with Claude Code in a Neovim terminal, and then i
6146
- [Claude Code CLI](https://github.com/anthropics/claude-code) tool installed and available in your PATH
6247
- [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) (dependency for git operations)
6348

64-
## Version
65-
66-
Current version: 0.4.2 - See [CHANGELOG.md](CHANGELOG.md) for details
49+
See [CHANGELOG.md](CHANGELOG.md) for version history and updates.
6750

6851
## Installation
6952

@@ -143,6 +126,21 @@ require("claude-code").setup({
143126

144127
## Usage
145128

129+
### Quick Start
130+
131+
```vim
132+
" In your Vim/Neovim commands or init file:
133+
:ClaudeCode
134+
```
135+
136+
```lua
137+
-- Or from Lua:
138+
vim.cmd[[ClaudeCode]]
139+
140+
-- Or map to a key:
141+
vim.keymap.set('n', '<leader>cc', '<cmd>ClaudeCode<CR>', { desc = 'Toggle Claude Code' })
142+
```
143+
146144
### Commands
147145

148146
- `:ClaudeCode` - Toggle the Claude Code terminal window

0 commit comments

Comments
 (0)