From 5125578d9ceb787b923a91f4416f4b49f18806f3 Mon Sep 17 00:00:00 2001
From: Bina <104396477+LierB@users.noreply.github.com>
Date: Sun, 12 May 2024 17:54:41 +0200
Subject: [PATCH] create README.md

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4d62ec1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# Fastfetch 
+
+<h3 align="left">
+Welcome to my fastfetch config presets repo :3
+</h3>
+
+[Fastfetch](https://github.com/fastfetch-cli/fastfetch) is a tool for fetching system information and displaying them in a pretty way. 
+In this repo, I collect my config files that I designed for my [Arch Linux](https://archlinux.org/) [Hyprland](https://github.com/hyprwm/Hyprland) rice. 
+Feel free to copy files and modify them or clone the complete repository.
+
+<p align="center">
+  <img src="./screenshots/floating-mode.png" style="width: 100%;">
+</p>
+
+## Usage
+
+Clone the repository into ``~/.local/share``
+
+```sh
+cd ~/.local/share
+git clone https://github.com/LierB/fastfetch
+```
+and execute your preferred files (e.g. ``groups.jsonc`` or ``minimal.jsonc``) with 
+
+```sh
+fastfetch --config groups
+fastfetch --config minimal
+```
+OR
+
+Copy your preferred config file (if necessary images/ascii-art files), rename it to ``config.jsonc``, move it to ``~/.config/fastfetch`` and execute it with 
+
+```sh
+fastfetch
+# or with additional options e.g.
+fastfetch --colors-block-range-start 9 --colors-block-width 3
+```