feat: add a readme

README.md

@@ -0,0 +1,96 @@
+<h1 align="center">Alejandra 💅</h2>
+
+<p align="center">The Uncompromising Nix Code Formatter</p>
+
+<p align="center">
+  <a
+    href="https://coveralls.io/github/kamadorueda/.github?branch=main"
+  >
+    <img
+      alt="Coverage"
+      src="https://coveralls.io/repos/github/kamadorueda/.github/badge.svg?branch=main"
+    >
+    </img>
+  </a>
+  <a
+    href="https://github.com/kamadorueda/alejandra/blob/main/UNLICENSE"
+  >
+    <img
+      alt="License: The Unlicense"
+      src="https://img.shields.io/badge/license-The Unlicense-green.svg"
+    >
+  </a>
+  <a
+    href="https://github.com/kamadorueda/alejandra"
+  >
+    <img
+      alt="style: Alejandra"
+      src="https://img.shields.io/badge/code%20style-Alejandra-green.svg"
+    >
+  </a>
+</p>
+
+## Getting started
+
+Let's get Alejandra on our systems:
+
+- Nix with Flakes:
+
+  ```bash
+  $ nix run github:kamadorueda/alejandra -- --help
+  ```
+
+- Nix stable:
+
+  Pick one depending on your platform:
+  ```bash
+  $ nix-env -ivA aarch64-darwin -f https://github.com/kamadorueda/alejandra/tarball/main
+  $ nix-env -ivA aarch64-linux -f https://github.com/kamadorueda/alejandra/tarball/main
+  $ nix-env -ivA i686-linux -f https://github.com/kamadorueda/alejandra/tarball/main
+  $ nix-env -ivA x86_64-darwin -f https://github.com/kamadorueda/alejandra/tarball/main
+  $ nix-env -ivA x86_64-linux -f https://github.com/kamadorueda/alejandra/tarball/main
+  ```
+
+  Then run with:
+
+  ```bash
+  $ alejandra --help
+  ```
+
+## Goals
+
+- ✔️ **Fast**
+
+  It's written in rust
+  and formats [Nixpkgs](https://github.com/NixOS/nixpkgs)
+  in under 1 minute.
+
+- ✔️ **Highly tested**
+
+  Coverage currently > 80%,
+  aiming to a 💯% soon.
+
+- ✔️ **Comprehensive**
+
+  All elements in the Nix grammar have a rule,
+  so there won't be portions of code unformatted.
+
+- ✔️ **Reproducible**
+
+  Formatting many times yields the same results.
+
+- 🚧 **Beautiful**
+
+  Beauty is subjective, right?
+
+  Yet there are a few improvements to implement like:
+  - Multiline strings indentation `'' ... ''`.
+  - Multiline comments indentation `/* ... */`.
+  - Not indenting attr sets, lists, or parenthesis after binding `name = {`.
+  - And many more as community feedback drives.
+
+  Style is negotiable at this moment.
+
+## Do I need to configure anything?
+
+- No.