mirror of
https://github.com/chenasraf/DefinitelyTyped-tools.git
synced 2026-05-18 01:49:03 +00:00
update README
This commit is contained in:
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user