Skip to content

Commit

Permalink
docs: better fields (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
gbprod authored Mar 17, 2022
1 parent 34adf9b commit b467732
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# ✂️ cutlass.nvim

[![Integration](https://github.com/gbprod/cutlass.nvim/actions/workflows/integration.yml/badge.svg)](https://github.com/gbprod/cutlass.nvim/actions/workflows/integration.yml)
![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/gbprod/cutlass.nvim/Integration?style=for-the-badge)

Cutlass overrides the delete operations to actually just delete and not affect the current yank.

Expand All @@ -10,7 +11,7 @@ It overrides the following keys to always use the black hole register: `c`, `cc`

Note that if you have already mapped these keys to something else (like we do below with `x`) then it will not change it again.

## Why would you want to do this?
## 🤔 Why would you want to do this?

See [here](http://vimcasts.org/blog/2013/11/registers-the-good-the-bad-and-the-ugly-parts/).
This plugin [already exists](https://github.com/svermeulen/vim-cutlass) in vimscript. I hope this version in lua will be more efficient :)
Expand Down
9 changes: 5 additions & 4 deletions doc/cutlass.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Table of Contents *cutlass.nvim-table-of-contents*

1. ✂️ cutlass.nvim |cutlass.nvim-✂️-cutlass.nvim|
- ✨ Features |cutlass.nvim-✨-features|
- Why would you want to do this?|cutlass.nvim--why-would-you-want-to-do-this?|
- 🤔 Why would you want to do this?|cutlass.nvim-🤔-why-would-you-want-to-do-this?|
- ⚡️ Requirements |cutlass.nvim-⚡️-requirements|
- 📦 Installation |cutlass.nvim-📦-installation|
- ⚙️ Configuration |cutlass.nvim-⚙️-configuration|
Expand All @@ -16,9 +16,10 @@ Table of Contents *cutlass.nvim-table-of-contents*
1. ✂️ cutlass.nvim *cutlass.nvim-✂️-cutlass.nvim*

<img
src='https://github.com/gbprod/cutlass.nvim/actions/workflows/integration.yml/badge.svg'
src='https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua'
title=''/> <img
src='https://img.shields.io/github/workflow/status/gbprod/cutlass.nvim/Integration?style=for-the-badge'
title=''/>
<https://github.com/gbprod/cutlass.nvim/actions/workflows/integration.yml>

Cutlass overrides the delete operations to actually just delete and not affect
the current yank.
Expand All @@ -31,7 +32,7 @@ It overrides the following keys to always use the black hole register: `c`,
Note that if you have already mapped these keys to something else (like we do
below with `x`) then it will not change it again.

WHY WOULD YOU WANT TO DO THIS?*cutlass.nvim--why-would-you-want-to-do-this?*
🤔 WHY WOULD YOU WANT TO DO THIS?*cutlass.nvim-🤔-why-would-you-want-to-do-this?*

See here
<http://vimcasts.org/blog/2013/11/registers-the-good-the-bad-and-the-ugly-parts/>.
Expand Down

0 comments on commit b467732

Please sign in to comment.