docs: add troubleshooting docs

Document usage of the DEBUG environment variable. Fixes #16.
max-mapper · Mar 25, 2020 · e8dae76 · e8dae76
1 parent af00186
commit e8dae76
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -0,0 +1,8 @@
+## Debugging `extract-zip`
+
+One way to troubleshoot potential problems is to set the `DEBUG` environment variable before
+importing / calling `extract-zip`. Setting its value to `extract-zip` will produce debugging
+information as a ZIP file is extracted.
+
+We use the [`debug`](https://www.npmjs.com/package/debug#usage) module for this functionality. It
+has examples on how to set environment variables if you don't know how.