update docs
This commit is contained in:
parent
2bf0f3317a
commit
d90d09919f
2 changed files with 29 additions and 4 deletions
28
README.md
28
README.md
|
@ -3,11 +3,35 @@
|
|||
|
||||
[![Build Status](https://dev.azure.com/vscode/VSCE/_apis/build/status/VSCE?branchName=master)](https://dev.azure.com/vscode/VSCE/_build/latest?definitionId=16&branchName=master)
|
||||
|
||||
### Requirements
|
||||
## Requirements
|
||||
|
||||
- [Node.js](https://nodejs.org/en/) at least `8.x.x`
|
||||
|
||||
### About
|
||||
## Development
|
||||
|
||||
First clone this repository, then:
|
||||
|
||||
```sh
|
||||
yarn
|
||||
yarn watch # or `watch-test` to also run tests
|
||||
```
|
||||
|
||||
Once the watcher is up and running, you can run out of sources with:
|
||||
|
||||
```sh
|
||||
yarn vsce
|
||||
```
|
||||
|
||||
### Publish to NPM
|
||||
|
||||
Simply push a new tag and the CI will automatically publish to NPM. The usual flow is:
|
||||
|
||||
```sh
|
||||
npm version [minor|patch]
|
||||
git push --follow-tags
|
||||
```
|
||||
|
||||
## About
|
||||
|
||||
This tool assists in packaging and publishing Visual Studio Code extensions.
|
||||
|
||||
|
|
|
@ -28,7 +28,8 @@
|
|||
"watch": "concurrently \"tsc --watch\" \"cpx --watch src/vsce out\"",
|
||||
"watch-test": "concurrently \"tsc --watch\" \"cpx --watch src/vsce out\" \"mocha --watch\"",
|
||||
"test": "mocha",
|
||||
"prepublishOnly": "tsc && cpx src/vsce out && mocha"
|
||||
"prepublishOnly": "tsc && cpx src/vsce out && mocha",
|
||||
"vsce": "out/vsce"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 8"
|
||||
|
@ -77,4 +78,4 @@
|
|||
"typescript": "^3.4.3",
|
||||
"xml2js": "^0.4.12"
|
||||
}
|
||||
}
|
||||
}
|
Loading…
Add table
Reference in a new issue