From c04110c380168615ee1ca6016108345b5563b6aa Mon Sep 17 00:00:00 2001
From: Tom McLaughlin <tom@codedown.io>
Date: Mon, 5 Feb 2024 19:15:43 -0800
Subject: [PATCH] Update README.md and add CHANGELOG.md

---
 CHANGELOG.md | 13 +++++++++++++
 README.md    | 14 +++++++++++++-
 2 files changed, 26 insertions(+), 1 deletion(-)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..d8d1ae2
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,13 @@
+# ChangeLog
+
+## 2.0.0
+
+* Added TreeMap visualizations.
+
+## 1.0.1
+
+* Be able to control dependency paths with environment variables so it's easier to package on Nixpkgs.
+
+## 1.0.0
+
+* Initial release.
diff --git a/README.md b/README.md
index bc98334..3c09047 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,7 @@ stack build --ghc-options "-ddump-to-file -ddump-timings"
 
 # Tips
 
-The script will output its log messages to `stderr` and print the final report path to `stdout` (assuming it didn't exit with a failure). This makes it easy to use the output in scripts. For example:
+* The script will output its log messages to `stderr` and print the final report path to `stdout` (assuming it didn't exit with a failure). This makes it easy to use the output in scripts. For example:
 
 ``` shell
 # Build the report and open it in your browser
@@ -70,6 +70,18 @@ The script will output its log messages to `stderr` and print the final report p
 > cp $(/path/to/time-ghc-modules/time-ghc-modules) $MY_CI_ARTIFACTS_DIR/
 ```
 
+* You can also look at the timing of individual components, but doing e.g. `stack build some-component:lib`. But, make sure to clean up any old `.dump-timings` files from previous runs:
+
+``` shell
+find . -name "*.dump-timings" | xargs rm
+```
+
+* GHC's `-dumpdir` option can be used to consolidate the `.dump-timings` files, so they aren't left all over your source tree. For example:
+
+``` shell
+stack build --ghc-options "-ddump-to-file -ddump-timings -dumpdir .ghcdump"
+```
+
 # Compatibility
 
 The flag `-ddump-timings` is available for `GHC >= 8.4.1`.