Skip to content

Improve instructions on how to use this package #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcelocra wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve instructions on how to use this package #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,31 @@

[![codecov](https://codecov.io/gh/GoogleChrome/chrome-types/branch/main/graph/badge.svg?token=X84QMcCoGI)](https://codecov.io/gh/GoogleChrome/chrome-types)

⚠️ **If you're looking for TypeScript definitions for Chrome's extensions, you should depend on [chrome-types](https://www.npmjs.com/package/chrome-types) in your project.**
## Quick start

To use this package, run:

```bash
# Or yarn, or npm.
$ pnpm add -D chrome-types
```

And then add `chrome-types` to your `tsconfig.json`:

```json5
{
"compilerOptions": {
// ...
"types": ["chrome-types"]
},
// ...
}
```

## What is this

This repo contains JS which parses Chrome's internal extension definitions and outputs TypeScript Definition files.
You shouldn't depend on this code: rather, the _generated_ types file is published at [chrome-types](https://www.npmjs.com/package/chrome-types).
You shouldn't depend on this code, but on the _generated_ types file is published at [chrome-types](https://www.npmjs.com/package/chrome-types), as shown in the [Quick start section above](#quick-start).
Depend on it for your Chrome extensions projects (MV3 and above).

## Design
Expand Down