Skip to content

Commit b722a79

Browse files
committed
Docs: Update documentation to reflect recent changes
- Document dependency updates workflow - Update test initialization file naming - Add pre-commit hook details
1 parent abee391 commit b722a79

2 files changed

Lines changed: 67 additions & 16 deletions

File tree

README.md

Lines changed: 66 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,46 @@
1-
# Claude Code Neovim Plugin
2-
3-
A Neovim plugin for seamless integration between [Claude Code](https://github.com/anthropics/claude-code) AI assistant and Neovim.
1+
<div align="center">
42

5-
This plugin was entirely built with Claude Code in a Neovim terminal, and then inside itself using Claude Code for everything.
3+
# Claude Code Neovim Plugin
64

7-
![Claude Code in Neovim](https://github.com/greggh/claude-code.nvim/blob/main/assets/claude-code.png?raw=true)
5+
[![GitHub License](https://img.shields.io/github/license/greggh/claude-code.nvim?style=flat-square)](https://github.com/greggh/claude-code.nvim/blob/main/LICENSE)
6+
[![GitHub Stars](https://img.shields.io/github/stars/greggh/claude-code.nvim?style=flat-square)](https://github.com/greggh/claude-code.nvim/stargazers)
7+
[![GitHub Issues](https://img.shields.io/github/issues/greggh/claude-code.nvim?style=flat-square)](https://github.com/greggh/claude-code.nvim/issues)
8+
[![CI](https://img.shields.io/github/actions/workflow/status/greggh/claude-code.nvim/ci.yml?branch=main&style=flat-square&logo=github)](https://github.com/greggh/claude-code.nvim/actions/workflows/ci.yml)
9+
[![Neovim Version](https://img.shields.io/badge/Neovim-0.7%2B-blueviolet?style=flat-square&logo=neovim)](https://github.com/neovim/neovim)
10+
[![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)
11+
[![Version](https://img.shields.io/badge/Version-0.3.0-blue?style=flat-square)](https://github.com/greggh/claude-code.nvim/releases/tag/v0.3.0)
12+
13+
*A seamless integration between [Claude Code](https://github.com/anthropics/claude-code) AI assistant and Neovim*
14+
15+
[Features](#features)
16+
[Requirements](#requirements)
17+
[Installation](#installation)
18+
[Configuration](#configuration)
19+
[Usage](#usage)
20+
[Contributing](#contributing)
21+
[Discussions](https://github.com/greggh/claude-code.nvim/discussions)
22+
23+
<img src="https://github.com/greggh/claude-code.nvim/blob/main/assets/claude-code.png?raw=true" alt="Claude Code in Neovim" width="800" />
24+
25+
</div>
26+
27+
This plugin was built entirely with Claude Code in a Neovim terminal, and then inside itself using Claude Code for everything!
28+
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)
844

945
## Features
1046

@@ -17,7 +53,7 @@ This plugin was entirely built with Claude Code in a Neovim terminal, and then i
1753
- 🧩 Modular and maintainable code structure
1854
- 📋 Type annotations with LuaCATS for better IDE support
1955
- ✅ Configuration validation to prevent errors
20-
- 🧪 Testing framework for reliability
56+
- 🧪 Testing framework for reliability (44 comprehensive tests)
2157

2258
## Requirements
2359

@@ -149,6 +185,8 @@ Contributions are welcome! Please check out our [contribution guidelines](CONTRI
149185

150186
MIT License - See [LICENSE](LICENSE) for more information.
151187

188+
## Development
189+
152190
For a complete guide on setting up a development environment, installing all required tools, and understanding the project structure, please refer to [DEVELOPMENT.md](DEVELOPMENT.md).
153191

154192
### Development Setup
@@ -157,8 +195,9 @@ The project includes comprehensive setup for development:
157195

158196
- Complete installation instructions for all platforms in [DEVELOPMENT.md](DEVELOPMENT.md)
159197
- Pre-commit hooks for code quality
160-
- Testing framework with Plenary.nvim
198+
- Testing framework with 44 comprehensive tests
161199
- Linting and formatting tools
200+
- Weekly dependency updates workflow for Claude CLI and actions
162201

163202
```bash
164203
# Run tests
@@ -167,20 +206,32 @@ make test
167206
# Check code quality
168207
make lint
169208

209+
# Set up pre-commit hooks
210+
scripts/setup-hooks.sh
211+
170212
# Format code
171213
make format
172214
```
173215

174-
## Development Cost
216+
## Community
175217

176-
This entire plugin was developed using Claude Code. Here's what it cost to build the initial version:
218+
- [GitHub Discussions](https://github.com/greggh/claude-code.nvim/discussions) - Get help, share ideas, and connect with other users
219+
- [GitHub Issues](https://github.com/greggh/claude-code.nvim/issues) - Report bugs or suggest features
220+
- [GitHub Pull Requests](https://github.com/greggh/claude-code.nvim/pulls) - Contribute to the project
177221

178-
```
179-
Total cost: $5.42
180-
Total duration (API): 17m 12.9s
181-
Total duration (wall): 2h 29m 29.2s
182-
```
222+
## Acknowledgements
223+
224+
- [Claude Code](https://github.com/anthropics/claude-code) by Anthropic - This plugin was entirely built using Claude Code. Development cost: $5.42 with 17m 12.9s of API time
225+
- [Plenary.nvim](https://github.com/nvim-lua/plenary.nvim) - Core dependency for testing framework and Git operations
226+
- [Semantic Versioning](https://semver.org/) - Versioning standard used in this project
227+
- [Contributor Covenant](https://www.contributor-covenant.org/) - Code of Conduct standard
228+
- [Keep a Changelog](https://keepachangelog.com/) - Changelog format
229+
- [LuaCATS](https://luals.github.io/wiki/annotations/) - Type annotations for better IDE support
230+
- [StyLua](https://github.com/JohnnyMorganz/StyLua) - Lua code formatter
231+
- [Luacheck](https://github.com/lunarmodules/luacheck) - Lua static analyzer and linter
183232

184233
---
185234

186-
💻 Created by [greggh](https://github.com/greggh)
235+
<div align="center">
236+
<p>Made with ❤️ by <a href="https://github.com/greggh">greggh</a></p>
237+
</div>

tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The test suite currently contains 44 tests covering all major components of the
4646

4747
## Minimal Test Configuration
4848

49-
The `minimal-init.lua` file provides a minimal Neovim configuration for testing the Claude Code plugin in isolation. This is useful for:
49+
The `minimal-init.lua` file provides a minimal Neovim configuration for testing the Claude Code plugin in isolation. This standardized initialization file (recently renamed from `minimal_init.lua` to match conventions used across related Neovim projects) is useful for:
5050

5151
1. Reproducing and debugging issues
5252
2. Testing new features in a clean environment

0 commit comments

Comments
 (0)