Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
deerawan committed Jul 5, 2017
1 parent 4bc8c15 commit 11cdede
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## 1.7.0
- Add two new commands! (thx to [Logan Saso](https://github.com/HazardDev))

## 1.6.0
- Add haml support

Expand Down
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,16 @@ Also support [Zeal](https://zealdocs.org/) for Windows and Linux.
Type `cmd + shift + p` to launch command palette and choose `Extensions: Install Extension`. Search this package and install.

## Usage
Get the text under your cursor or selected first.
Get the text under your cursor or selected first:

- Pressing `ctrl + h`. It will search for current specific documentation depends on language.
- Pressing `ctrl + alt + h`. It will search for all documentation.

No need to select the text:

- Pressing `ctrl + shift + h`. It will open dash with current file's docset.
- Pressing `alt + h`. It will open dash with custom string and current file's docset.

## Supported Docsets
This plugin supports almost all docset configuration based on [Dash Mapping](https://kapeli.com/dash_plugins)

Expand Down Expand Up @@ -112,5 +117,12 @@ Add one or two lines below
{ "key": "your_shortcut", "command": "extension.dash.searchSyntax" } // open dash with custom string and current file's docset
```

## Contributors
Thank you for these awesome contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
| [<img src="https://avatars.githubusercontent.com/u/1243921?v=3" width="100px;"/><br /><sub>Budi Irawan</sub>](https://budiirawan.com) | [<img src="https://avatars.githubusercontent.com/u/8567599?v=3" width="100px;"/><br /><sub>Zhongren Shao</sub>](https://github.com/szhongren) | [<img src="https://avatars.githubusercontent.com/u/6226408?v=3" width="100px;"/><br /><sub>Logan Saso</sub>](https://github.com/HazardDev) |
| :--- | :---: | ---: |

## License
MIT © [Budi Irawan](https://budiirawan.com)

0 comments on commit 11cdede

Please sign in to comment.