Skip to content

Commit

Permalink
Merge pull request #2 from TylerLeonhardt/patch-1
Browse files Browse the repository at this point in the history
README updates
  • Loading branch information
Yatao Li authored Apr 18, 2019
2 parents 3167b34 + 4b9066e commit c6ccd69
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,40 @@
# coc-pses
[PowerShellEditorService](https://github.com/PowerShell/PowerShellEditorServices) integration for [coc.nvim](https://github.com/neoclide/coc.nvim)

Recommend to install with a plugin manager, for example:
A vim plugin powered by
[PowerShellEditorService](https://github.com/PowerShell/PowerShellEditorServices) and
[coc.nvim](https://github.com/neoclide/coc.nvim)
to provide a rich PowerShell editing experience.

Features include:
* Intellisense/Completions
* Go to definition
* [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) integration
* and much more!

## Prerequisites

1. vim/neovim
1. [PowerShell Core](https://github.com/powershell/powershell) or Windows PowerShell

## Installation

### (Recommended) Install with a plugin manager like [vim-plug](https://github.com/junegunn/vim-plug):

1. Add this to your `vimrc`/`Init.vim`
```vimL
Plug 'yatli/coc-pses', {'do': { -> coc#pses#install()} }
...
Plug 'neoclide/coc.nvim', {'tag': '*', 'do': { -> coc#util#install()}}
```
2. Reload vim.
1. Run the vim command: `:PlugInstall`.

## TODO
- pwsh core support
- xplat support
- REPL?
- [x] pwsh core support
- [x] xplat support
- [ ] REPL?

## Recommended plugins

[vim-polyglot](https://github.com/sheerun/vim-polyglot) for syntax highlighting 🎨

0 comments on commit c6ccd69

Please sign in to comment.