Skip to content

Commit f288807

Browse files
author
Kylie Stewart
authored
Remove links to DefinitelyTyped in favor of local type defs (#632)
1 parent 397a793 commit f288807

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Thanks for taking the time to help us make Spectacle even better! Before you go
4040

4141
- Run the tests using `yarn run test`.
4242
- Run lint and flow using `yarn run lint`
43-
- Open a PR in [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/spectacle/index.d.ts) for anything that modifies the Spectacle API, like breaking changes or new features.
43+
- Update the [type definitions](./index.d.ts) for anything that modifies the Spectacle API, like breaking changes or new features.
4444
- Everything else included in our [pull request checklist](https://github.com/FormidableLabs/spectacle/blob/master/.github/PULL_REQUEST_TEMPLATE.md#checklist-feel-free-to-delete-this-section-upon-completion)
4545

4646
## Releasing a new version to NPM (only for project administrators)

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -453,11 +453,9 @@ const CustomHeading = styled(Heading)`
453453

454454
**_Can I write my presentation in TypeScript?_**
455455

456-
Yes, you can! Updated type definitions for the Spectacle API can be found within [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/spectacle/index.d.ts). You can bring them into your project using `yarn` or `npm`:
456+
Yes, you can! Type definitions are shipped with the library, so you can import Spectacle components into any `.tsx` presentation without additional installation steps.
457457

458-
```sh
459-
npm i --save @types/spectacle
460-
```
458+
Updated type definitions for the Spectacle API can be found [at the root of this repository](./index.d.ts).
461459

462460
## Tag API
463461

0 commit comments

Comments
 (0)