Skip to content

Commit

Permalink
feat(readme): added 'how to' to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mahdi Karimi committed Dec 19, 2021
1 parent 26f4d51 commit 97c8533
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
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.

0 comments on commit 97c8533

Please sign in to comment.