From 248db51c04558dd1fee6eb542959ace27548448f Mon Sep 17 00:00:00 2001
From: Neal Caffery <bing.ecnu@gmail.com>
Date: Sat, 13 Jul 2024 10:46:31 +0800
Subject: [PATCH] add tip for the JSON output

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 9c26c22c..9592f5ee 100644
--- a/README.md
+++ b/README.md
@@ -62,6 +62,13 @@ Then, run the linter by:
 nilaway -include-pkgs="<YOUR_PKG_PREFIX>,<YOUR_PKG_PREFIX_2>" ./...
 ```
 
+> [!TIP]  
+> Disable the `pretty-print` flag when output as JSON:
+> ```shell
+> nilaway -json -pretty-print=false -include-pkgs="<YOUR_PKG_PREFIX>,<YOUR_PKG_PREFIX_2>" ./...
+> ```
+
+
 ### golangci-lint (>= v1.57.0)
 
 NilAway, in its current form, can report false positives. This unfortunately hinders its immediate