Skip to content

Commit

Permalink
Udpate readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Thiel committed Jun 1, 2019
1 parent 310cd6a commit 0ae156e
Showing 1 changed file with 43 additions and 2 deletions.
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,46 @@
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.

### Tasks
### Installation

* [ ] Simple CLI to list top-level directories similar to sn-sort
Via `cargo`, which can be obtained using [rustup][rustup]

```
cargo install dua-cli
```

### Usage

```bash
# count the space used in the current working directory
dua
# count the space used in all directories that are not hidden
dua *
# learn about additional functionality
dua aggregate --help
```

### Roadmap

#### 2.0

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

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.

### Development

#### Run tests

```bash
make journey-tests
```

#### Learn about other targets

```
make
```

[rustup]: https://rustup.rs/

0 comments on commit 0ae156e

Please sign in to comment.