From 84f9b7a72c16487b2b4be82d30fc15e55df8304d Mon Sep 17 00:00:00 2001
From: Muhammad Nauman Raza <devraza.hazard643@slmail.me>
Date: Sun, 24 Mar 2024 13:16:20 +0000
Subject: [PATCH] docs: improve README.md

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3b27c3b..9b53316 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
 # bunbun
+> A simple and adorable sysinfo utility written in Rust.
 
-A simple and adorable sysinfo utility written in Rust.
\ No newline at end of file
+## Installation
+To build `bunbun`, you'll need [Rust](https://rust-lang.org) installed:
+```bash
+$ git clone https://git.devraza.duckdns.org/devraza/bunbun
+$ cd bunbun
+$ cargo build --release # `--release` adds a few optimisations
+```
+
+> **Using the flake!**
+> This repository contains a `flake.nix` - if you have Nix installed, you can run `nix run github:devraza/bunbun` to compile and run the program.
+
+## Inspiration
+- [Rosettea/bunnyfetch](https://github.com/Rosettea/bunnyfetch)
+- [elenapan's `bunnyfetch` script](https://github.com/elenapan/dotfiles/blob/master/bin/bunnyfetch)
+
+## License
+This project is covered by the [MIT License](./LICENSE).