Skip to content

Commit a19e007

Browse files
docs: improve the readme (#230)
2 parents 7654262 + 4a823b9 commit a19e007

1 file changed

Lines changed: 22 additions & 5 deletions

File tree

packages/pack-n-play/README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
1+
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
12

23
# Post Install Check
4+
> Make sure TypeScript projects can use the `d.ts` you're feeding them.
35
4-
> *This is not an officially supported Google product.*
6+
**This is not an officially supported Google product.**
57

6-
It seems to be fairly easy to have a library written in TypeScript that exports type definitions that cannot be used by dependent code. Typically if the library does not export all types correctly, a TypeScript codebase using the library will fail to compile, potentially forcing the codebase to use the library without typechecks.
8+
It's not uncommon to ship a library written in TypeScript that exports type definitions that cannot be used by dependent code. Typically if the library does not export all types correctly, a TypeScript codebase using the library will fail to compile, potentially forcing the codebase to use the library without typechecks.
79

810
The Install Check library is designed to be used as part of the tests for your library to verify that your library can be used by dependent code.
911

10-
# Example
12+
## Installation
1113

14+
```sh
15+
$ npm install --save-dev post-install-check
16+
```
17+
18+
## Usage
1219
The following could be the contents of a test file in your module that is run with `mocha` as part of your test suite.
1320

1421
```ts
15-
16-
import * as check from 'install-check';
22+
import * as check from 'post-install-check';
1723

1824
const tsCode = `
1925
import * as express from 'express';
@@ -73,3 +79,14 @@ check.testInstallation(TS_SAMPLES, JS_SAMPLES, {
7379
timeout: 2*60*1000
7480
});
7581
```
82+
83+
## Questions/problems?
84+
If you've found an bug/issue, please [file it on GitHub](https://github.com/google/post-install-check/issues).
85+
86+
## Contributing
87+
See [CONTRIBUTING](https://github.com/google/post-install-check/blob/master/CONTRIBUTING.md).
88+
89+
## License
90+
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/google/post-install-check/blob/master/LICENSE).
91+
92+
*Made with ❤️ by the Google Node.js team*

0 commit comments

Comments
 (0)