From d2bc516c746c51fa16699e5fc5fc96324ec60d57 Mon Sep 17 00:00:00 2001
From: tux <t@tux.rs>
Date: Fri, 28 Feb 2025 00:58:20 +0530
Subject: [PATCH] docs: update README.md

---
 README.md | 106 +++++++++---------------------------------------------
 1 file changed, 16 insertions(+), 90 deletions(-)

diff --git a/README.md b/README.md
index 6827f74..bc4bc33 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 <h3 align="center">
-  tux's Nix Flake
+  tux's awesomeWM config
 </h3>
 <p align="center">
   <a href="https://wakatime.com/badge/user/012e8da9-99fe-4600-891b-bd9d8dce73d9/project/312e6509-0e4f-47b7-b5de-54985b546702" target="_blank"><img alt="home" src="https://wakatime.com/badge/user/012e8da9-99fe-4600-891b-bd9d8dce73d9/project/312e6509-0e4f-47b7-b5de-54985b546702.svg"></a>
@@ -10,102 +10,28 @@
 	<img src="https://github.com/user-attachments/assets/fc28c35f-b87a-4931-ae7f-c231a11fd1a3" alt="desktop">
 </p>
 
-## Table of Contents
-
-- [Hosts](#hosts)
-- [Installation](#installation)
-- [Components](#components)
-- [Showcase](#showcase)
-- [Pain](#spent-weeks-on-this-system-configuration-)
-
-## Hosts
-
-|     | Type    | Name     | Hardware                                | Purpose                                                                            |
-| --- | ------- | -------- | --------------------------------------- | ---------------------------------------------------------------------------------- |
-| 💻  | Desktop | sirius   | Ryzen 5 3600 - 64GB RAM - RTX 3080 TI   | Multi-monitor desktop running Windows Subsystem for Linux.                         |
-| 🖥️  | Laptop  | canopus  | Ryzen 9 5900HS - 16 GB RAM - RTX 3060   | Optimized for productivity on the go and some gaming.                              |
-| 🖥️  | Server  | homelab  | Ryzen 7 8700G - 32 GB RAM - Radeon 780M | WIP                                                                                |
-| ☁️  | VPS     | arcturus | 4 Core - 8 GB RAM                       | Primary server responsible for exposing my homelab applications to the internet.   |
-| 🥔  | VPS     | alpha    | 2 Core - 4 GB RAM                       | Monitors uptime and health status of all services across the infrastructure.       |
-| 🥔  | Server  | vega     | Cortex A53 - 1 GB RAM                   | Running AdGuard Home for network-wide ad blocking.                                 |
-| ☁️  | VPS     | capella  | 4 Core - 6 GB RAM                       | For running Minecraft, CS 2, Rust game servers.                                    |
-| 📱  | VPS     | rigel    | S21 Ultra - 12 GB RAM                   | Yes, I run nix on my android device. lol                                           |
-| ☁️  | VPS     | node     | i9-13900 - 64 GB RAM                    | Running Ethereum and BSC nodes. Currently in the process of migrating from Ubuntu. |
-
 ## Installation
 
-Boot into NixOS bootable USB and then enter the following commands
+```nix
+# Add to your flake inputs
+tawm = {
+  url = "github:tuxdotrs/tawm";
+  inputs.nixpkgs.follows = "nixpkgs";
+};
 
+# Add this in your HomeManager config
+{ inputs, ... }: {
+  home.file = {
+    ".config/awesome" = {
+      recursive = true;
+      source = "${inputs.tawm.packages.x86_64-linux.default}";
+    };
+  };
+}
 ```
-# Clone this repositry
-git clone https://github.com/tuxdotrs/nix-config.git
-
-# Navigate to the repository directory
-cd nix-config
-
-# Install disko for disk partitioning
-nix-shell -p disko
-
-# Partition the disk and make sure to replace DISK_PATH (eg. /dev/vda)
-disko --mode disko ./hosts/canopus/disko.nix --arg device '"DISK_PATH"'
-
-# Generate the hardware.nix file for your system
-nixos-generate-config --no-filesystems --root /mnt
-
-# Replace the hardware.nix with generated one
-cp /mnt/etc/nixos/hardware-configuration.nix ./hosts/canopus/hardware.nix
-
-# Install
-nixos-install --root /mnt --flake .#canopus
-
-# Reboot to your beautiful DE
-reboot
-```
-
-## Components
-
-|               | Wayland | Xorg             |
-| ------------- | ------- | ---------------- |
-| DM            | /       | SDDM             |
-| WM/DE         | /       | AwesomeWM        |
-| Compositor    | /       | Picom (Jonaburg) |
-| Bar           | /       | Wibar            |
-| Hotkeys       | /       | Awful            |
-| Launcher      | /       | Rofi             |
-| Notifications | /       | Naughty          |
-| Terminal      | /       | Wezterm          |
-| Editor        | /       | Neovim           |
 
 ## Showcase
 
-### Desktop
-
 ![2024-08-08_18-33](https://github.com/user-attachments/assets/1cdcc387-0f68-486c-a76c-a36ad2acb78d)
 
 ![2024-08-08_18-18](https://github.com/user-attachments/assets/f3fc4da5-6c0d-4cda-934d-b68ca6494e02)
-
-### Neovim
-
-![2024-08-08_18-16](https://github.com/user-attachments/assets/f881c672-8d77-43ec-b637-df5004c7d11f)
-
-### Floating Terminal
-
-![2024-08-08_18-16_1](https://github.com/user-attachments/assets/3339ecf8-3264-4179-a093-337c844592a6)
-
-### Lazygit
-
-![2024-08-08_18-16_2](https://github.com/user-attachments/assets/6df15881-fc2b-41b1-af3b-124fe0599b94)
-
-### Telescope
-
-![2024-08-08_18-16_3](https://github.com/user-attachments/assets/03be05bc-8ede-4d6e-a341-2761d89b7288)
-
-### Firefox
-
-![2024-08-08_18-26](https://github.com/user-attachments/assets/6f12173b-2480-404e-b01a-599115a886c0)
-
-## Spent weeks on this system configuration 😢
-
-<div align="center">
-  <img src="https://user-images.githubusercontent.com/97862450/265550523-2f66a8b6-4347-40af-89c6-12db3a61cc7c.jpeg" width="60%">
-</div>