Document options parameter (#428)

Turbo87 · Jan 6, 2025 · 028b9bf · 028b9bf
1 parent 07b47ac
commit 028b9bf
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -104,6 +104,15 @@ var x = {
 
 For more examples have a look at our [test suite](test.ts).
 
+Options
+------------------------------------------------------------------------------
+
+A second options argument can be passed. The **lenient** option allows parsing to proceed even if some errors are found.
+
+```js
+let result = IGCParser.parse(fs.readFileSync('1G_77fv6m71.igc', 'utf8'), { lenient: true });
+```
+
 
 Similar work
 ------------------------------------------------------------------------------