diff --git a/README.md b/README.md index 42aebcb..0c66259 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,17 @@ Lightweight and nimble git client for nvim. -showcase commit message writing +showcase commit message input field + +*Commit Message Input Field with Syntax Highlighting* + +showcase commit message notification + +*Informative Notifications with Highlighting when using `nvim-notify`* + +## Table of Contents + - - [Features](#features) - [Installation](#installation) - [Usage](#usage) @@ -15,10 +23,12 @@ Lightweight and nimble git client for nvim. - [Configuration](#configuration) - [Non-Goals](#non-goals) - [Credits](#credits) - + + ## Features - Smart-Commit: Open a popup to enter a commit message. If there are no staged changed, stages all changes before doing so (`git add -A`). +- Option to automatically open references GitHub issues in the browser after committing. - Commit Messages have syntax highlighting, indicators for [commit message overlength](https://stackoverflow.com/questions/2290016/git-commit-messages-50-72-formatting), and optionally enforce conventional commits keywords. - Option to run `git push` in a non-blocking manner after committing. - Quick amends.