Skip to content

Commit

Permalink
feat(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mahdi Karimi committed Dec 19, 2021
1 parent 97c8533 commit d361605
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
# vscode-webvue

vscode webview extension template using vue 3 and vite ⚡

## 🚀 How to use it?
## 🚀 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.
after vscode instance opened up use command pallate and then select the `hello world` command

![](/docs/screenshot.png)

Here you can see your vue project already built and injected using vscode webview API. you can utilize the full functionality of vue such as its amazing reactivity and its available plugins out of the box!

when you 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.
Binary file added docs/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d361605

Please sign in to comment.