From 6e2d91b87aeedf181945bc0c7cbcd4270b280e2a Mon Sep 17 00:00:00 2001
From: utox39 <francescomoccaldi39@gmail.com>
Date: Sat, 12 Apr 2025 23:40:18 +0200
Subject: [PATCH] docs(README): update README

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index 6fe87a5..bcfd541 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,34 @@
 # Zigfetch
+
+## Description
+
+Zigfetch is a minimal [neofetch](https://github.com/dylanaraps/neofetch)/[fastfetch](https://github.com/fastfetch-cli/fastfetch) like system information tool
+
+## Requirements
+
+- [zig v0.14.0](https://ziglang.org/)
+
+## Installation
+
+```console
+# Clone the repo
+$ git clone https://github.com/utox39/zigfetch.git
+
+# cd to the path
+cd path/to/zigfetch
+
+# Build zigfetch
+$ zig build -Doptimize=ReleaseSafe run
+
+# Then move it somewhere in your $PATH. Here is an example:
+$ mv zigfetch ~/bin
+```
+
+## Usage
+
+```console
+$ zigfetch
+```
+
+## Contributing
+If you would like to contribute to this project just create a pull request which I will try to review as soon as possible.