From e8dae76676b4c6a1a54725411ca2815536957b95 Mon Sep 17 00:00:00 2001 From: Mark Lee Date: Wed, 25 Mar 2020 13:02:10 -0700 Subject: [PATCH] docs: add troubleshooting docs Document usage of the DEBUG environment variable. Fixes #16. --- SUPPORT.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 SUPPORT.md diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..53ab67c --- /dev/null +++ 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.