Skip to content

Commit d90d099

Browse files
committed
update docs
1 parent 2bf0f33 commit d90d099

File tree

2 files changed

+29
-4
lines changed

2 files changed

+29
-4
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,35 @@
33
44
[![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)
55

6-
### Requirements
6+
## Requirements
77

88
- [Node.js](https://nodejs.org/en/) at least `8.x.x`
99

10-
### About
10+
## Development
11+
12+
First clone this repository, then:
13+
14+
```sh
15+
yarn
16+
yarn watch # or `watch-test` to also run tests
17+
```
18+
19+
Once the watcher is up and running, you can run out of sources with:
20+
21+
```sh
22+
yarn vsce
23+
```
24+
25+
### Publish to NPM
26+
27+
Simply push a new tag and the CI will automatically publish to NPM. The usual flow is:
28+
29+
```sh
30+
npm version [minor|patch]
31+
git push --follow-tags
32+
```
33+
34+
## About
1135

1236
This tool assists in packaging and publishing Visual Studio Code extensions.
1337

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@
2828
"watch": "concurrently \"tsc --watch\" \"cpx --watch src/vsce out\"",
2929
"watch-test": "concurrently \"tsc --watch\" \"cpx --watch src/vsce out\" \"mocha --watch\"",
3030
"test": "mocha",
31-
"prepublishOnly": "tsc && cpx src/vsce out && mocha"
31+
"prepublishOnly": "tsc && cpx src/vsce out && mocha",
32+
"vsce": "out/vsce"
3233
},
3334
"engines": {
3435
"node": ">= 8"
@@ -77,4 +78,4 @@
7778
"typescript": "^3.4.3",
7879
"xml2js": "^0.4.12"
7980
}
80-
}
81+
}

0 commit comments

Comments
 (0)