From 021d6a529780701e9a9512a3e975888b0d65f740 Mon Sep 17 00:00:00 2001 From: Gireesh Punathil Date: Mon, 4 Nov 2019 14:15:13 +0530 Subject: [PATCH 1/3] doc: add info about DEBUG mode Many issues pertinent to session management can be easily diagnosed with debug on. Make a statement to that effect in the README to help users self-assist to an extent. Refs: https://github.com/expressjs/session/issues/659 --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a1ed3fa1..47970e19 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,16 @@ This is a [Node.js](https://nodejs.org/en/) module available through the $ npm install express-session ``` +## Debugging + +```sh +$ export DEBUG=express-session +``` + +Setting this property prior to the run (use `set` in Windows) +enables `debug` mode, and prints minimal but vital debug +information pertinent to the life cycle of the session. + ## API ```js From 3233c00855af369e57191d719da52b7390280538 Mon Sep 17 00:00:00 2001 From: Gireesh Punathil Date: Sat, 1 Feb 2020 10:58:01 +0530 Subject: [PATCH 2/3] fixup: address review comments --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 47970e19..59f7f6b1 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,9 @@ $ export DEBUG=express-session ``` Setting this property prior to the run (use `set` in Windows) -enables `debug` mode, and prints minimal but vital debug -information pertinent to the life cycle of the session. +enables [`debug`](https://www.npmjs.com/package/debug) mode, +and prints minimal but vital debug information pertinent +to the life cycle of the session. ## API From be610cb6f1b95d311b3fcdd921cf26cca6b78f4c Mon Sep 17 00:00:00 2001 From: Gireesh Punathil Date: Sat, 1 Feb 2020 12:49:56 +0530 Subject: [PATCH 3/3] fixup: reverse examples between win and unix --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 59f7f6b1..22c10054 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,10 @@ $ npm install express-session ## Debugging ```sh -$ export DEBUG=express-session +$ set DEBUG=express-session ``` -Setting this property prior to the run (use `set` in Windows) +Setting this property prior to the run (use `export` in UNIX) enables [`debug`](https://www.npmjs.com/package/debug) mode, and prints minimal but vital debug information pertinent to the life cycle of the session.