~willdurand/srht.vim

1578395403afc10dbbef22fd6b3cd493e324d4df — William Durand 3 years ago 1473ccc
Update docs
1 files changed, 16 insertions(+), 12 deletions(-)

M README.md
M README.md => README.md +16 -12
@@ 9,21 9,25 @@ In doubt, run `:help srht`.

This plugin provides the following features per service:

- `git.sr.ht`: if [vim-fugitive](https://github.com/tpope/vim-fugitive) is
  installed, this plugin will allow `:GBrowse` to open sourcehut URLs
- `paste.sr.ht`: create and retrieve pastes (requires `curl` and the
  [webapi-vim](https://github.com/mattn/webapi-vim) plugin)
- `git.sr.ht`:
  - if [vim-fugitive](https://github.com/tpope/vim-fugitive) is
    installed, this plugin will allow `:GBrowse` to open sourcehut URLs
- `paste.sr.ht`:
  - create and retrieve pastes with `:SrhtPaste` (requires `curl` and the
    [webapi-vim](https://github.com/mattn/webapi-vim) plugin)

### Configuration

- `g:srht_token_file` (default: `~/.srht-vim`): path to filename containing a
   sourcehut personal access token (which is only required for commands that
   interact with the sourcehut APIs)
- `g:srht_paste_default_visibility` (default: `unlisted`): default paste
   visibility
- `g:srht_paste_domain` (default: `paste.sr.ht`): domain of the paste hosting
   service
- `g:srht_git_domain` (default: `git.sr.ht`): domain of the git hosting service
- `g:srht_token_file`: path to the file containing a sourcehut personal access
  token (which is only required for commands that interact with the sourcehut
  APIs)
  - default: `~/.srht-vim`
- `g:srht_paste_default_visibility`: default paste visibility
  - default: `unlisted`
- `g:srht_paste_domain`: domain of the paste hosting service
  - default: `paste.sr.ht`
- `g:srht_git_domain`: domain of the git hosting service
  - default: `git.sr.ht`

## Installation