-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(readme): added 'how to' to readme
- Loading branch information
Mahdi Karimi
committed
Dec 19, 2021
1 parent
26f4d51
commit 97c8533
Showing
1 changed file
with
12 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,14 @@ | ||
# vscode-webvue | ||
vscode webview extension template using vue 3 and vite ⚡ | ||
|
||
## 🚀 How to use it? | ||
The project is build with monorepo structure containing two packages. The first one is the client and the second one is the vscode extension code itself. | ||
|
||
For running project in development mode use: | ||
|
||
```bash | ||
yarn run watch | ||
``` | ||
and then start developing on the `/packages/client/` vue application directory. your changes will be watched using nodemon, then rebuilt and be opened inside vscode extension host ready to be used with vscode command pallate! | ||
|
||
Inside the vue application code, the `vscode` object is globally injected and can be used to send messages to the vscode runtime and perform tasks such as read/writing files, etc. |