summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Thiel <sthiel@thoughtworks.com>2019-06-01 16:39:25 +0530
committerSebastian Thiel <sthiel@thoughtworks.com>2019-06-01 16:39:25 +0530
commite8a83e779f694a8ba2a264a5def7add6d65b191c (patch)
tree3406160e30cba1cd9864cb985c392a31b4594b86
parenta66cf95bf57f477eae7a8ef307fd62a4df0da76d (diff)
Better readme
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7bdbe71..5f2b844 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-DUA (-> Disk Usage Analyzer) is a tool to conveniently learn about the usage of memory of a given directory. It's parallel by default and will max out your SSD, providing relevant information as fast as possible.
+**dua** (-> _Disk Usage Analyzer_) is a tool to conveniently learn about the usage of disk space of a given directory. It's parallel by default and will max out your SSD, providing relevant information as fast as possible.
[![asciicast](https://asciinema.org/a/au3neIHDGtYYj4blyTXR8VkJz.svg)](https://asciinema.org/a/au3neIHDGtYYj4blyTXR8VkJz)
@@ -23,11 +23,11 @@ dua aggregate --help
### Roadmap
-#### 2.0
+#### 🚧v2.0 (_wip_) - interactive visualization of directory sizes with an option to queue their deletion
A sub-command bringing up a terminal user interface to allow drilling into directories, and clearing them out, all just using the keyboard.
-#### 1.0
+#### ✅v1.0 (_released_) - aggregate directories, fast
Simple CLI to list top-level directories similar to sn-sort, but faster and more tailored to getting an idea of where most space is used.
@@ -45,4 +45,10 @@ make journey-tests
make
```
+### Acknowledgements
+
+Thanks to [jwalk][jwalk], all there was left to do is to write a command-line interface. As `jwalk` matures, **dua** should benefit instantly.
+
+
[rustup]: https://rustup.rs/
+[jwalk]: https://crates.io/crates/jwalk