Skip to content

Commit 067df0b

Browse files
authored
docs: add help file (#80)
* docs: describe behavior * docs: add help close #26 Release-As: 1.0.0
1 parent 9910584 commit 067df0b

File tree

2 files changed

+53
-4
lines changed

2 files changed

+53
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,29 @@
1+
# vim-textobj-bettertag
2+
13
[![vim-themis](https://github.com/Omochice/vim-textobj-bettertag/actions/workflows/ci.yml/badge.svg)](https://github.com/Omochice/vim-textobj-bettertag/actions/workflows/ci.yml)
24

3-
# vim-textobj-bettertag
5+
This plugin provides a mapping: `<Plug>(textobj-bettertag-i)`.
6+
7+
If you place the cursor on `|` position.
48

9+
```html
10+
<div>
11+
| some text
12+
</div>
13+
```
514

6-
This plugin provide mapping: `<Plug>(textobj-bettertag-i)`.
15+
When you run `dit` you will get the following:
716

17+
```html
18+
<div>|</div>
19+
```
20+
21+
If you map this plugin as `onoremap it <Plug>(textobj-bettertag-i)`, you will get:
22+
23+
```html
24+
<div>
25+
|</div>
26+
```
827

928
## Coverage
1029

@@ -15,6 +34,6 @@ Currently, there are tested on Linux only.
1534
|stable |[![coverage-vim-stable](https://omochice.github.io/vim-textobj-bettertag/badge-Linux-vim-stable.svg)](https://github.com/Omochice/vim-textobj-bettertag/actions/workflows/ci.yml)|[![coverage-nvim-stable](https://omochice.github.io/vim-textobj-bettertag/badge-Linux-neovim-stable.svg)](https://github.com/Omochice/vim-textobj-bettertag/actions/workflows/ci.yml)|
1635
|nightly|[![coverage-vim-nightly](https://omochice.github.io/vim-textobj-bettertag/badge-Linux-vim-nightly.svg)](https://github.com/Omochice/vim-textobj-bettertag/actions/workflows/ci.yml)|[![coverage-nvim-nightly](https://omochice.github.io/vim-textobj-bettertag/badge-Linux-neovim-nightly.svg)](https://github.com/Omochice/vim-textobj-bettertag/actions/workflows/ci.yml)|
1736

37+
## License
1838

19-
20-
39+
[zlib](./LICENSE)

doc/vim-textobj-bettertag.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
*vim-textobj-bettertag.txt* tag textobj without beginning of newline
2+
3+
==============================================================================
4+
vim-textobj-bettertag ~
5+
*vim-textobj-bettertag*
6+
7+
- Dependencies |vim-textobj-bettertag-dependencies|
8+
- Interface |vim-textobj-bettertag-interface|
9+
10+
------------------------------------------------------------------------------
11+
Dependencies ~
12+
*vim-textobj-bettertag-dependencies*
13+
This plugin needs:
14+
15+
- https://github.com/kana/vim-textobj-user
16+
17+
------------------------------------------------------------------------------
18+
Interface *vim-textobj-bettertag-interface*
19+
20+
This plugin provides `<Plug>(textobj-bettertag-i)` only.
21+
22+
You can map this as instead of `it`:
23+
24+
>vim
25+
xnoremap it <Plug>(textobj-bettertag-i)
26+
onoremap it <Plug>(textobj-bettertag-i)
27+
<
28+
29+
==============================================================================
30+
vim:tw=78:ts=8:ft=help:norl:et:fen:fdl=0:

0 commit comments

Comments
 (0)