Skip to content

Commit

Permalink
Add documentation to the ignore option
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas Parisot committed Sep 23, 2021
1 parent 7ffed27 commit 1db0a5e
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,23 @@ crx.load( path.resolve(__dirname, './myExtension') )
```

### ChromeExtension = require("crx")
### crx = new ChromeExtension(attrs)
### crx = new ChromeExtension(attrs?)

This module exports the `ChromeExtension` constructor directly, which can take an optional attribute object, which is used to extend the instance.

`attrs` is an optional object with advanced configuration elements:

```js
crx = new ChromeExtension({
// By default, we exclude bundling crx extensions within extensions
// You can change that, and ignore other files as well
ignore: ['*.crx']
// By default, it produces extensions compatible with CRX version 3 (since Chromium 64)
// CRX version 2 is for Chromium versions prior to 64
version: 3
})
```

### crx.load(path|files)

Prepares the temporary workspace for the Chrome Extension located at `path` — which is expected to directly contain `manifest.json`.
Expand Down

0 comments on commit 1db0a5e

Please sign in to comment.