diff options
| author | FabulousCupcake <mail.fabulous.cupcake@gmail.com> | 2020-01-10 11:53:40 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-10 11:53:40 +0100 |
| commit | dbf86db4e2e205d7bdc64c92a64ac4299b585c63 (patch) | |
| tree | 4b0b3783c44eb4f7eef3da807448a14b2d068455 /README.md | |
| parent | 0abbec30a738e4deda00176383e474b4cff002a7 (diff) | |
Update README.md
- Add table of contents
- Add homebrew shield
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 24 insertions, 5 deletions
@@ -1,6 +1,6 @@ # Broot -[![CI][s3]][l3] [![MIT][s2]][l2] [![Latest Version][s1]][l1] [![Chat on Miaou][s4]][l4] +[![CI][s3]][l3] [![MIT][s2]][l2] [![Latest Version][s1]][l1] [![Homebrew Formula][s5]][l5] [![Chat on Miaou][s4]][l4] [s1]: https://img.shields.io/crates/v/broot.svg [l1]: https://crates.io/crates/broot @@ -14,9 +14,30 @@ [s4]: https://miaou.dystroy.org/static/shields/room.svg [l4]: https://miaou.dystroy.org/3490?broot +[s5]: https://img.shields.io/homebrew/v/broot +[l5]: https://formulae.brew.sh/formula/broot + A better way to navigate directories -[jump to installation](https://dystroy.org/broot/documentation/installation/) + +Table of Contents +================= + + * [Installation](#installation) + * [Feature Showcase](#feature-showcase) + * [Get an overview of a directory, even a big one](#get-an-overview-of-a-directory-even-a-big-one) + * [Find a directory then `cd` to it](#find-a-directory-then-cd-to-it) + * [Never lose track of file hierarchy while you search](#never-lose-track-of-file-hierarchy-while-you-search) + * [Manipulate your files](#manipulate-your-files) + * [Apply a standard or personal shortcut to a file](#apply-a-standard-or-personal-shortcut-to-a-file) + * [Replace `ls` (and its clones)](#replace-ls-and-its-clones) + * [See what takes space](#see-what-takes-space) + * [Further Reading](#further-reading) + +## Installation +Full installation documentation can be found [here](https://dystroy.org/broot/documentation/installation/). + +## Feature Showcase ### Get an overview of a directory, even a big one @@ -98,7 +119,5 @@ And you keep all broot tools, like filtering or the ability to delete or open fi Sizes are computed in the background, you don't have to wait for them when you navigate. -### More... - +## Further Reading See **[Broot's web site](https://dystroy.org/broot)** for instructions regarding installation and usage. - |