Readme update

README.md

@@ -1,49 +1,60 @@
-# Ouch!
+<p align="center">
+  <a href="https://crates.io/crates/ouch">
+    <img src="https://img.shields.io/crates/v/ouch?color=6090FF&style=flat-square" alt="Crates.io link">
+  </a>
+  <a href="https://docs.rs/ouch">
+    <img src="https://img.shields.io/docsrs/ouch?color=6090FF&style=flat-square" alt="Docs.rs link">
+  </a>
+  <a href="https://github.com/ouch/ouch-org/blob/master/LICENSE">
+    <img src="https://img.shields.io/crates/l/ouch?color=6090FF&style=flat-square" alt="License">
+  </a>
+</p>
 
-[![crates.io](https://img.shields.io/crates/v/ouch.svg?style=for-the-badge&logo=rust)](https://crates.io/crates/ouch) [![license](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge&logo=Open-Source-Initiative&logoColor=ffffff)](https://github.com/ouch-org/ouch/blob/main/LICENSE)
+# Ouch!
 
-`ouch` stands for **Obvious Unified Compression Helper**, it's a CLI tool to compress and decompress files.
+`ouch` stands for **Obvious Unified Compression Helper** and is a CLI tool to help you compress and decompress files of several formats.
 
 - [Features](#features)
 - [Usage](#usage)
 - [Installation](#installation)
 - [Supported Formats](#supported-formats)
+- [Benchmarks](#benchmarks)
 - [Contributing](#contributing)
 
-## Features
+# Features
 
 1. Easy to use.
-2. Automatic format detection.
-3. Same syntax, various formats.
-4. Encoding and decoding streams, it's fast. <!-- We should post benchmarks in our wiki and link them here -->
+2. Infers expression formats automatically.
+3. Uses the same usage syntax for all supported formats.
+4. Achieves great performance through encoding and decoding streams.
 5. No runtime dependencies (for _Linux x86_64_).
 6. Listing archive contents with tree formatting (in next release!).
 
-## Usage
+# Usage
 
-### Decompressing
+## Decompressing
 
 Use the `decompress` subcommand and pass the files.
 
 ```sh
-# Decompress one
+# Decompress a file
 ouch decompress a.zip
 
-# Decompress multiple
+# Decompress multiple files
 ouch decompress a.zip b.tar.gz c.tar
 
 # Short alternative
 ouch d a.zip
 ```
 
-You can redirect the decompression results to another folder with the `-d/--dir` flag.
+The `-d/--dir` flag can be used to redirect decompression results to another directory.
 
 ```sh
 # Decompress 'summer_vacation.zip' inside of new folder 'pictures'
-ouch decompress summer_vacation.zip -d pictures
+ouch decompress summer_vacation.zip --dir pictures
 ```
 
-### Compressing
+## Compressing
 
 Use the `compress` subcommand, pass the files and the **output file** at the end.
 
@@ -53,51 +64,85 @@ ouch compress 1 2 3 4 archive.zip
 
 # Short alternative
 ouch c file.txt file.zip
-
-# Compress everything in the current folder again and again
-ouch compress * everything.tar.gz.xz.bz.zst.gz.gz.gz.gz.gz
 ```
 
-`ouch` checks for the extensions of the **output file** to decide which formats should be used.
+`ouch` detects the extensions of the **output file** to decide what formats to use.
+
+# Supported formats
+
+| Format    | `.tar` | `.zip` | `.bz`, `.bz2` | `.gz` | `.lz4` | `.xz`, `.lz`, `.lzma` | `.zst` |
+|:---------:|:------:|:------:|:-------------:|:-----:|:------:|:---------------------:|:------:|
+| Supported | ✓     | ✓      | ✓            | ✓     | ✓     | ✓                     | ✓     |
+
+And the aliases: `tgz`, `tbz`, `tbz2`, `tlz4`, `txz`, `tlz`, `tlzma`, `tzst`.
+
+Formats can be chained (`ouch` keeps it _fast_):
+
+- `.gz.xz.bz.zst`
+- `.tar.gz.xz.bz.zst`
+- `.tar.gz.gz.gz.gz.xz.xz.xz.xz.bz.bz.bz.bz.zst.zst.zst.zst`
 
-## Installation
+# Installation
 
 [![Packaging status](https://repology.org/badge/vertical-allrepos/ouch.svg)](https://repology.org/project/ouch/versions)
 
-### Downloading the latest binary
+## Downloading the latest binary
 
 Compiled for `x86_64` on _Linux_, _Mac OS_ and _Windows_, run with `curl` or `wget`.
 
-| Method    | Command                                                                            |
-|:---------:|:-----------------------------------------------------------------------------------|
+| Method    | Command                                                                             |
+|:---------:|:------------------------------------------------------------------------------------|
 | **curl**  | `curl -s https://raw.githubusercontent.com/ouch-org/ouch/master/install.sh \| sh`   |
 | **wget**  | `wget https://raw.githubusercontent.com/ouch-org/ouch/master/install.sh -O - \| sh` |
 
+The script will copy the [latest binary](https://github.com/ouch-org/ouch/releases) to `/usr/local/bin`.
 
-The script will download the [latest binary](https://github.com/ouch-org/ouch/releases) and copy it to `/usr/bin`.
+## Minimum Supported Rust Version
 
-### Installing from source code
+`ouch` will always be developed with the latest stable release of the Rust toolchain.
 
-For compiling, check the [wiki guide](https://github.com/ouch-org/ouch/wiki/Compiling-and-installing-from-source-code).
+## Installing from source code
 
-## Supported formats
+Check the [wiki guide](https://github.com/ouch-org/ouch/wiki/Compiling-and-installing-from-source-code).
 
-| Format        | .tar | .zip | .bz, .bz2 | .gz | .lz4 | .xz, .lz, .lzma | .zst |
-|:-------------:|:----:|:----:|:---------:|:---:|:----:|:---------------:|:----:|
-| Supported     | ✓    | ✓    | ✓         | ✓   | ✓    | ✓               | ✓    |
+# Dependencies
 
-And the aliases: `tgz`, `tbz`, `tbz2`, `tlz4`, `txz`, `tlz`, `tlzma`, `tzst`.
+When built dynamically linked, you'll need these libraries to be available on your system:
 
-Formats can be chained (`ouch` keeps it _fast_):
+* [liblzma](https://www.7-zip.org/sdk.html)
+* [libbz2](https://www.sourceware.org/bzip2/)
+* [libz](https://www.zlib.net/)
 
-- `.gz.xz.bz.zst`
-- `.tar.gz.xz.bz.zst`
-- `.tar.gz.gz.gz.gz.xz.xz.xz.xz.bz.bz.bz.bz.zst.zst.zst.zst`
+Thankfully these are all very common libraries that _should_ already be available on all mainstream Linux distributions and on macOS.
+
+`ouch` is also easily built with MUSL, in which case it's _statically linked_ and therefore has no runtime dependencies. 
+
+# Benchmarks
 
-## Contributing
+Comparison made decompressing `linux.tar.gz` and measured with
+[Hyperfine](https://github.com/sharkdp/hyperfine) and the values presented are the average (wall clock) elapsed time.
 
-`ouch` is 100% made out of voluntary work, any small contribution is welcome!
+| Tool         | `ouch` | [`tar`] | [`bsdtar`] |
+|:------------:|:------:|:-------:|:----------:|
+| Average time | 911 ms | 1102 ms |   829 ms   |
 
-- Open an issue.
+Note: `ouch` focuses heavily on usage ergonomics and nice error messages, but
+we plan on doing some optimization in the future.
+
+Versions used:
+
+- `ouch` _0.3.1_
+- [`tar`] _1.34_
+- [`bsdtar`] _3.5.2_
+
+# Contributing
+
+`ouch` is made out of voluntary work, contributors are very welcome! No contribution is too small and all contributions are valued.
+
+- Open an [issue](https://github.com/ouch-org/ouch/issues).
+- Package it for your favorite distribution or package manager.
 - Open a pull request.
-- Share it to a friend!
+- Share it with a friend!
+
+[`tar`]: https://www.gnu.org/software/tar/
+[`bsdtar`]: https://www.freebsd.org/cgi/man.cgi?query=bsdtar&sektion=1&format=html

src/commands.rs

@@ -143,7 +143,7 @@ pub fn run(args: Opts, question_policy: QuestionPolicy) -> crate::Result<()> {
                 // Note: If input_extensions is empty then it will make `formats` empty too, which we don't want
                 if !input_extensions.is_empty() && new_formats != formats {
                     // Safety:
-                    //   We checked above that input_extensions isn't empty, so files[0] has a extension.
+                    //   We checked above that input_extensions isn't empty, so files[0] has an extension.
                     //
                     //   Path::extension says: "if there is no file_name, then there is no extension".
                     //   Using DeMorgan's law: "if there is    extension, then there is    file_name".