ankit02327 / ankit02327/nvim-config

Update and Modernise README.md

Abierto
#2 0 comentarios 0 reacciones 1 asignado Reclamado por @ankit02327 Ver en GitHub
documentation enhancement
Lenguaje dominante
Lua
Estrellas
3
Forks
0
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

The current README.md contains detailed information about features and structure, but it’s overwhelming and lacks clear usage instructions for quick on-boarding. A streamlined, modernised README would make the project far more accessible.

Suggested Improvements
- Screenshots & GIFs
- Show the configuration in action (before/after comparison).
- Add a quick GIF for workflows (e.g., fuzzy finding, LSP integration, file explorer toggle).
- Demo Video
- A short video walking through setup and everyday usage (compile & run, navigation, etc.).
- Modern README Components
- Badges (Neovim version, License, Stars).
- Clear, minimal installation & usage instructions at the top.
- Collapsible sections for advanced configuration.
- Concise, bulleted feature overview.
- Visual Enhancements
- Simple diagrams/graphs showing modular config structure or plugin architecture.
- Flowchart of how startup works with lazy.nvim.
- Support & Community
- Add “Support this project” section (e.g., Buy Me a Coffee / GitHub Sponsors).
- Clear contributing guidelines link.

This update will make the README:
- Readable for newcomers in 1–2 minutes.
- Actionable with quick copy-paste install steps.
- Engaging with visuals that demonstrate value.

⚡ By doing this, the README will reflect the polish of the configuration itself and help attract more users & contributors.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.