Skip to content

Commit 67bc2e7

Browse files
committed
📝 Add readme
1 parent 82e736f commit 67bc2e7

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# posh-yarn-completion
2+
[![license](https://img.shields.io/github/license/gluons/posh-yarn-completion.svg?style=flat-square)](./LICENSE)
3+
[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/yarn-completion.svg?style=flat-square)](https://www.powershellgallery.com/packages/yarn-completion/)
4+
[![PowerShell Gallery](https://img.shields.io/powershellgallery/dt/yarn-completion.svg?style=flat-square)](https://www.powershellgallery.com/packages/yarn-completion/)
5+
6+
A [Yarn](https://yarnpkg.com/) tab completion for [PowerShell](https://microsoft.com/powershell).
7+
8+
## ⚙️ Installation
9+
10+
Install from [PowerShell Gallery](https://www.powershellgallery.com/)
11+
12+
```powershell
13+
Install-Module yarn-completion -Scope CurrentUser
14+
```
15+
16+
---
17+
18+
⚠️ If you haven't allowed script execution policy, set your script execution policy to `RemoteSigned` or `Unrestricted`.
19+
20+
```powershell
21+
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
22+
```
23+
24+
## 🛂 Usage
25+
26+
You have to import the module to use `yarn-completion`.
27+
28+
Add below command into your PowerShell profile.
29+
30+
```powershell
31+
Import-Module yarn-completion
32+
```
33+
34+
Then restart your PowerShell.
35+
Now you can use tab completion with **Yarn**.
36+
37+
---
38+
39+
⚠️ If you don't have PowerShell profile yet, create it with below command!
40+
41+
```powershell
42+
New-Item -ItemType File $profile
43+
```

0 commit comments

Comments
 (0)