From d1619150696eeae8ad5e8edb39d2bc32a0acd1a0 Mon Sep 17 00:00:00 2001
From: Thomas Parisot <oncletom@users.noreply.github.com>
Date: Thu, 23 Sep 2021 20:16:06 +0200
Subject: [PATCH] Add documentation to the `ignore` option

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 47d4450..20e8b30 100644
--- a/README.md
+++ b/README.md
@@ -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`.