Skip to content

docs: add demo GIF to README #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wassimk merged 1 commit into from
Mar 15, 2026
Merged

docs: add demo GIF to README #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Autocomplete `Co-Authored-By` lines in git commits. Type a GitHub handle and
complete it to `Name <email>` format.

<!-- TODO: Add demo gif/video here -->
![demo](demo.gif)

## 📋 Requirements

Expand Down
Binary file added demo.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 7 additions & 1 deletion doc/git-coauthors.nvim.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*git-coauthors.nvim.txt* For NVIM v0.10.0 Last change: 2026 February 20
*git-coauthors.nvim.txt* For NVIM v0.10.0 Last change: 2026 March 15

==============================================================================
Table of Contents *git-coauthors.nvim-table-of-contents*
Expand All @@ -9,6 +9,7 @@ Table of Contents *git-coauthors.nvim-table-of-contents*
- 💻 Usage |git-coauthors.nvim-git-coauthors.nvim-💻-usage|
- 🔧 Configuration|git-coauthors.nvim-git-coauthors.nvim-🔧-configuration|
- 🔨 Development |git-coauthors.nvim-git-coauthors.nvim-🔨-development|
2. Links |git-coauthors.nvim-links|

==============================================================================
1. git-coauthors.nvim *git-coauthors.nvim-git-coauthors.nvim*
Expand Down Expand Up @@ -206,6 +207,11 @@ Enable the local git hooks (one-time setup):
git config core.hooksPath .githooks
<

==============================================================================
2. Links *git-coauthors.nvim-links*

1. *demo*: demo.gif

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

vim:tw=78:ts=8:noet:ft=help:norl:
Loading