From 36f6579dd21387b40900d35b6d8b87af314b60c6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=81ukasz=20Kurzyniec?= <lukasz.kurzyniec@xebia.com>
Date: Mon, 25 Sep 2023 12:51:28 +0200
Subject: [PATCH] added info to README how to run on plan file

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

diff --git a/README.md b/README.md
index 7845a6f..dd4c6db 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,23 @@ $ docker run --rm -it -p 9000:9000 -v $(pwd):/src im2nguyen/rover
 
 Once Rover runs on `0.0.0.0:9000`, navigate to it to find the visualization!
 
+### Run on Terraform plan file
+
+Use `-planJSONPath` to start Rover on Terraform plan file. The `plan.json` file should be in Linux version - Unix (LF), UTF-8.
+
+First, generate the plan file in JSON format.
+
+```
+$ terraform plan -out plan.out
+$ terraform show -json plan.out > plan.json
+```
+
+Then, run Rover on it.
+
+```
+$ docker run --rm -it -p 9000:9000 -v $(pwd)/plan.json:/src/plan.json im2nguyen/rover:latest -planJSONPath=plan.json
+```
+
 ### Standalone mode
 
 Standalone mode generates a `rover.zip` file containing all the static assets.