Skip to content

Commit 8ea7d01

Browse files
authored
Merge pull request #18 from electron/rename2
rename more things
2 parents 10d9455 + 3cb0cc7 commit 8ea7d01

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# electron-DefinitelyTyped [![Build Status](https://travis-ci.org/electron/electron-typescript-definitions.svg?branch=master)](https://travis-ci.org/electron/electron-typescript-definitions)
1+
# Electron TypeScript Definitions [![Build Status](https://travis-ci.org/electron/electron-typescript-definitions.svg?branch=master)](https://travis-ci.org/electron/electron-typescript-definitions)
22

3-
Parse Electron's JSON API documentation and spit out a typescript definition file
3+
This module uses Electron's [JSON API documentation](https://electron.atom.io/blog/2016/09/27/api-docs-json-schema) to produce a TypeScript definition file.
44

55
## Installation
66

77
```sh
8-
npm install electron-DefinitelyTyped --save
8+
npm install electron-typescript-definitions --save
99
```
1010

1111
## CLI Usage
1212

1313
To generate the definitions
1414

1515
```sh
16-
electron-DefinitelyTyped --in=path/to/electron/api.json --out=path/to/electron.d.ts
16+
electron-typescript-definitions --in=path/to/electron/api.json --out=path/to/electron.d.ts
1717
```
1818

1919
Any warnings during the generation can normally be ignored unless it actually throws
@@ -25,7 +25,7 @@ The module exports a function that parses a given API JSON object and returns
2525
an array of lines to create the definition file
2626

2727
```js
28-
const generateDefinitions = require('electron-DefinitelyTyped')
28+
const generateDefinitions = require('electron-typescript-definitions')
2929
const apiPath = './vendor/electron/docs/api.json'
3030

3131
const definitionLines = generateDefinitions(require(apiPath))

0 commit comments

Comments
 (0)