From afa6db6e934b6b7cea50197d5451e450ef67fb65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Marcos=20Bezerra?= Date: Fri, 17 Sep 2021 03:31:18 -0300 Subject: [PATCH] Update README, add badges and fixes broken links --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1f094a2..ee96167 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,24 @@ # Ouch! +[![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` stands for **Obvious Unified Compression Helper**, and works on _Linux_, _Mac OS_ and _Windows_. -It is a CLI tool to compress and decompress files that aims to be easy to use. +It is a CLI tool to compress and decompress files that aims on ease of usage. -- [Installation](#Installation) -- [Usage](#Usage) - - [Decompressing files](#Decompressing-files) - - [Compressing files/directories](#Compressing-files-and-directories) -- [Supported Formats](#Supported-formats) -- [Supported operating systems](#Supported-operating-systems) +- [Usage](#usage) + - [Decompressing](#decompressing) + - [Compressing](#compressing) +- [Installation](#installation) + - [Latest binary](#downloading-the-latest-binary) + - [Compiling from source](#installing-from-source-code) +- [Supported Formats](#supported-formats) +- [Contributing](#contributing) ## Usage @@ -34,7 +38,7 @@ You can redirect the decompression results to a folder with the `-o/--output` fl ```sh # Create 'pictures' folder and decompress inside of it -ouch 1.tar.gz 2.tar.gz -o pictures +ouch a.zip -o pictures ``` ### Compressing @@ -59,8 +63,6 @@ ouch compress * files.zip `ouch` checks for the extensions of the **output file** to decide which formats should be used. -Check the [list of all file extensions supported](#Supported-formats). -