docs: add screenshot to readme

Change-Id: Ia21adc7f3dfed579f0204b16a45b147d8ec5e390
2 files changed
tree: b9d03e2f5bbae5cbd887e6201928f07d1504ff7c
  1. ftdetect/
  2. ftplugin/
  3. images/
  4. syntax/
  5. .gitreview
  6. LICENSE
  7. README.md
README.md

.jjdescription files plugin for Vim

This plugin adds syntax highlighting and some sensible options for .jjdescription files. These are temporary files created by JJ and opened in your configured editor when you run jj describe, so you can write a description for your change.

Screenshot showing the syntax highlighting

Installation

Use your favorite plugin manager to install the avm99963/vim-jjdescription plugin. For instance, with vim-plug you should add the following to the appropriate section in your .vimrc:

Plug 'avm99963/vim-jjdescription'

Credits

This plugin is based on the native syntax highlighting and ftplugin for gitcommit, which is the format of the analogous temporary files used by Git. This is the reason why this plugin is licensed with the Vim license.