morten/share.nvim
1
0
Fork 0
mirror of https://github.com/morten-olsen/share.nvim.git synced 2026-02-08 01:36:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Morten Olsen
2021-11-08 12:22:19 +01:00
committed by GitHub
parent f3a3d65d52
commit 5dbdeeb0f3
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -1,9 +1,15 @@
# share.nvim
A neovim plugin for sharing a visual selection using a messenger platform. Currently only Slack is supported, but Microsoft Teams is on the way.
This is my first neovim plugin, so it does have rough edges, be warned. PR for fixes or features are welcome.
![demo](./assets/demo.gif)
## Setup
Setup using `packer` or your favorite package manager. `share.nvim` does depend on `plenary` and `telescope` and will require nvim `0.5` or higher.
Invoke the `.setup` and pass in your providers.
```lua
use({
"morten-olsen/share.nvim",
@@ -25,6 +31,8 @@ use({
## Usage
The easiest way to use it is to setup keybindings for your individual providers and optinally formatting. Below is an example of setting up two key bindings for sharing to a slack provider both as markdown (default for slack provider) or as code (auto wrapping visual highlight in a code block)
```vim
" share as markdown
vnoremap <Leader>ss :!lua require("share").share("my_slack")