Sfoglia il codice sorgente

docs: improve README.md

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
Christina Sørensen 2 anni fa
parent
commit
2b708287af
1 ha cambiato i file con 10 aggiunte e 4 eliminazioni
  1. 10 4
      README.md

+ 10 - 4
README.md

@@ -2,15 +2,14 @@
 
 # eza
 
-eza is a modern, maintained replacement for ls, built on [exa](https://github.com/ogham/exa).
+A modern, maintained replacement for ls.
 
-**README Sections:** [Options](#options) — [Installation](#installation) — [Development](#development)
+
+<a href="https://matrix.to/#/#eza-community:gitter.im"><img alt="Gitter" src="https://img.shields.io/gitter/room/eza-community/eza?logo=element&link=https%3A%2F%2Fapp.gitter.im%2F%23%2Froom%2F%23eza%3Agitter.im&link=Gitter%20matrix%20room%20for%20Eza" width=200></a>
 
 [![Built with Nix](https://img.shields.io/badge/Built_With-Nix-5277C3.svg?logo=nixos&labelColor=73C3D5)](https://nixos.org)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
 
-<a href="https://matrix.to/#/#eza-community:gitter.im"><img alt="Gitter" src="https://img.shields.io/gitter/room/eza-community/eza?logo=element&link=https%3A%2F%2Fapp.gitter.im%2F%23%2Froom%2F%23eza%3Agitter.im&link=Gitter%20matrix%20room%20for%20Eza" width=200></a>
-
 [![Unit tests](https://github.com/eza-community/eza/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/eza-community/eza/actions/workflows/unit-tests.yml)
 ![Crates.io](https://img.shields.io/crates/v/eza?link=https%3A%2F%2Fcrates.io%2Fcrates%2Feza)
 ![Crates.io](https://img.shields.io/crates/l/eza?link=https%3A%2F%2Fgithub.com%2Feza-community%2Feza%2Fblob%2Fmain%2FLICENCE)
@@ -42,6 +41,9 @@ By deliberately making some decisions differently, eza attempts to be a more fea
 - Support for `bright` terminal colours.
 - Many smaller bug fixes/changes!
 
+...and like, so much more that it became exhausting to update this all the time.
+Like seriously, we have a lot of good stuff.
+
 ---
 
 <a id="try-it">
@@ -59,6 +61,9 @@ Nix will build eza and run it.
 If you want to pass arguments this way, use e.g. `nix run github:eza-community/eza -- -ol`.
 
 <a id="installation">
+<details>
+    <summary> Installation instructions </summary>
+
 <h1>Installation</h1>
 </a>
 
@@ -287,6 +292,7 @@ For reference:
 - https://docs.brew.sh/Shell-Completion#configuring-completions-in-zsh
 - https://github.com/Homebrew/brew/issues/8984
 
+</details>
 
 ---