Skip to content

Commit e8dae76

Browse files
committed
docs: add troubleshooting docs
Document usage of the DEBUG environment variable. Fixes #16.
1 parent af00186 commit e8dae76

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

SUPPORT.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Debugging `extract-zip`
2+
3+
One way to troubleshoot potential problems is to set the `DEBUG` environment variable before
4+
importing / calling `extract-zip`. Setting its value to `extract-zip` will produce debugging
5+
information as a ZIP file is extracted.
6+
7+
We use the [`debug`](https://www.npmjs.com/package/debug#usage) module for this functionality. It
8+
has examples on how to set environment variables if you don't know how.

0 commit comments

Comments
 (0)