Skip to content

Commit 8eb3036

Browse files
authored
Update README.md
1 parent 8c0fd7b commit 8eb3036

1 file changed

Lines changed: 31 additions & 4 deletions

File tree

README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,17 @@ This is polymer_ide plugin for vim version 8.0 and above. This plugin unlocks al
44

55
Features:
66

7-
* typeahead completions for imported elements, with documentation
8-
* typeahead completions for element attributes, with documentation
9-
* inline errors (squiggle underlines)
10-
* jump to definition support for custom elements and attributes
7+
* typeahead completions for imported elements, with documentation [pic](#Completions_with_documentation)
8+
* typeahead completions for element attributes, with documentation [pic](#Completions_with_documentation)
9+
* inline errors (marks on lines) [pic](#Navigation_by_errors)
10+
* jump to definition support for custom elements and attributes [pic](#Go_to_definition)
1111

12+
## Requirements
1213

14+
* Vim version 8.0 and above support;
15+
* node.js;
16+
* UltiSnips(option) for supprots snippets;
17+
1318
## Installation
1419

1520
Use your favorite package manager
@@ -23,9 +28,31 @@ For example, if you're using vim-plug, add the following line to `~/.vimrc`:
2328
```
2429
Plug 'webdesus/polymer-ide.vim'
2530
```
31+
Then go to plugin folder and execute
32+
```
33+
npm install
34+
```
2635

36+
For work using snippets needed install UltiSnips from this https://github.com/SirVer/ultisnips
37+
2738
## For more information, read documentation
2839

2940
```
3041
:h polymer_ide
3142
```
43+
## Features in a gif
44+
45+
### Completions with documentation <a name="Completions_with_documentation"></a>
46+
![preview](https://github.com/webdesus/polymer-ide.vim/raw/gh-pages/img/Completions.gif)
47+
48+
### Navigation by errors <a name="Navigation_by_errors"></a>
49+
![preview](https://github.com/webdesus/polymer-ide.vim/raw/gh-pages/img/Errors.gif)
50+
51+
### Go to definition <a name="Go_to_definition"></a>
52+
![preview](https://github.com/webdesus/polymer-ide.vim/raw/gh-pages/img/Go to definition.gif)
53+
54+
## Todo
55+
56+
* Get references for element
57+
* Write tests
58+
* etc...

0 commit comments

Comments
 (0)