update README

This commit is contained in:
Nathan Shively-Sanders
2020-04-29 10:22:30 -07:00
parent 86f5fcb214
commit 4a4f578b9c

View File

@@ -1,11 +1,16 @@
# `@definitelytyped/retag`
> TODO: description
Refresh tags on all DT-published packages in the @types scope.
Run this whenever an RC of Typescript is released.
1. `--dry` will not actually do the retag, but print what it would do.
2. `--name=X` will only retag ONE package, and is optional. This is only needed to fix types-publishers' mistakes, or to unwedge it after its cache is corrupted.
## Usage
```
const retag = require('@definitelytyped/retag');
// TODO: DEMONSTRATE API
$ node lib/retag.js
```
Make sure that you have an up-to-date Definitely Typed repo next to the DefinitelyTyped-tools directory.