readme + 1.7.0 version bumps

Author: solidiquis

Cargo.lock

@@ -1,11 +1,12 @@
 [package]
 name = "erdtree"
-version = "1.6.0"
+version = "1.7.0"
 edition = "2021"
 authors = ["Benjamin Nguyen <[email protected]>"]
 description = """
-erdtree (et) is vibrant multi-threaded filetree visualizer and disk usage analyzer
-that respects .gitignore and hidden file rules by default.
+erdtree (et) is a multi-threaded file-tree visualization and disk usage
+analysis tool that respects gitignore and hidden file rules offering a modern
+alternative to tree and du.
 """
 documentation = "https://github.com/solidiquis/erdtree"
 homepage = "https://github.com/solidiquis/erdtree"

Cargo.toml

@@ -5,7 +5,7 @@
 [![Packaging status](https://repology.org/badge/tiny-repos/erdtree.svg)](https://repology.org/project/erdtree/versions)
 [![Crates.io](https://img.shields.io/crates/d/erdtree)](https://crates.io/crates/erdtree)
 
-A modern, vibrant, and multi-threaded file-tree visualizer and disk usage analyzer that respects hidden files and `.gitignore` rules by default i.e. the secret love child of [tree](https://en.wikipedia.org/wiki/Tree_(command)) and [du](https://en.wikipedia.org/wiki/Du_(Unix)).
+A modern, multi-threaded file-tree visualization and disk usage analysis tool that respects hidden file and `.gitignore` i.e. the secret love child of [tree](https://en.wikipedia.org/wiki/Tree_(command)) and [du](https://en.wikipedia.org/wiki/Du_(Unix)).
 
 <p align="center">
   <img src="https://github.com/solidiquis/erdtree/blob/master/assets/demo.png?raw=true" alt="failed to load picture" />
@@ -22,6 +22,7 @@ A modern, vibrant, and multi-threaded file-tree visualizer and disk usage analyz
 * [Installation](#installation)
 * [Info](#info)
   - [Configuration file](#configuration-file)
+  - [Parallelism](#parallelism)
   - [Binary prefix or SI prefix](#binary-prefix-or-si-prefix)
   - [Logical or physical disk usage](#logical-or-physical-disk-usage)
   - [How are directory sizes computed](#how-are-directory-sizes-computed)
@@ -54,8 +55,6 @@ If the chosen defaults don't meet your requirements and you don't want to bloat
 
 ## Usage
 
-**Note**: The amount of threads used by default is dependent upon how many logical CPUs available in your system.
-
 ```
 erdtree (et) is a multi-threaded filetree visualizer and disk usage analyzer.
 
@@ -158,15 +157,37 @@ Arguments passed to `erdtree` take precedence. If you have a config that you wou
 Here is an example of a valid config:
 
 ```
-$ cat $HOME/.erdtreerc
---level 2
+$ cat $HOME/.config/erdtree/.erdtreerc
+# Long or short names work
+-s size
+
+# I prefer physical size
+--disk-usage physical
+
+# ooo pwetty
 --icons
---scale 3
 
-# You can use the short names too
--s size
+# This is prettier.. thanks bryceberger
+--size-left
+--prune
 ```
 
+### Parallelism
+
+A common question people have about `erdtree` is how it benefits from parallelism when disk I/O does serial processing, i.e. it can only ever service one request at a time.
+
+The idea behind leveraging parallelism for disk reads is that despite serial processing you'll still get higher throughput as saturating the disk queue depth with user-space requests allows it to process requests in aggregate rather than waiting for a single-thread to send a single request at a time and doing some CPU-bound work with the response before sending another.
+
+Here are some crude benchmarks demonstrating the relationship between performance and thread-count.
+
+<p align="center">
+  <img src="https://github.com/solidiquis/erdtree/blob/master/assets/thread_performance.png?raw=true" alt="failed to load png" />
+</p>
+
+It's important to note that some parallelism does improve performance but after a certain threshold you do get dimishing returns. As [Amdahl's law](https://en.wikipedia.org/wiki/Amdahl%27s_law) suggests, there is an asymptotic threshold for the speedup which is a function of thread-count. Once you've approached that threshold you're just paying the additional cost of managing a larger thread-pool with no added benefit.
+
+If you'd like more rigorous empirical data going into how parallelism benefits both SSD and HDD checkout [this article](https://pkolaczk.github.io/disk-parallelism/).
+
 ### Binary prefix or SI Prefix
 
 Disk usage is reported using binary prefixes by default (e.g. `1 KiB = 1024 B`) as opposed to SI prefixes (`1 KB = 1000 B`). To toggle between the two use the `-p, --prefix` option.

README.md

@@ -23,8 +23,8 @@ mod test;
 #[derive(Parser, Debug)]
 #[command(name = "erdtree")]
 #[command(author = "Benjamin Nguyen. <[email protected]>")]
-#[command(version = "1.6.0")]
-#[command(about = "erdtree (et) is a multi-threaded filetree visualizer and disk usage analyzer.", long_about = None)]
+#[command(version = "1.7.0")]
+#[command(about = "erdtree (et) is a multi-threaded file-tree visualization and disk usage analysis tool.", long_about = None)]
 pub struct Context {
     /// Include aggregate file count in tree output
     #[arg(short, long)]