From 7c8c9f329f8f4d8767c42c629c7a526cba1742c1 Mon Sep 17 00:00:00 2001 From: SirBlobby Date: Sat, 31 Oct 2026 21:17:42 -0400 Subject: [PATCH] Update README --- README.md | 42 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 39 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6773ea8..fb51c79 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,14 @@ The site recreates my [blomarchy](https://git.sirblob.co/SirBlob/blomarchy) setu ## Features - **Tiling windows** - every page opens as a window that tiles like Hyprland's dwindle layout, with gradient borders. -- **Quickshell bar** - app launcher, workspaces, clock, live Discord status, battery and a theme picker. +- **Quickshell bar** - app launcher, workspaces, clock, music player, live Discord status, battery details and a theme picker. +- **Music player** - plays a random song from a YouTube playlist, muted until you unmute it, with seek, skip, repeat, volume and a playlist view. +- **Image viewer** - click any image to open it in an imv window with zoom, pan, rotate, pinch and swipe. - **Kitty terminals** - a real command line with history and tab completion. Try `fastfetch`, `whoami` or `cowsay`. - **Desktop icons** - grouped into pages, terminal scripts and socials (GitHub, LinkedIn, Devpost, Discord). -- **13 themes** - Flats, Retro 82, Tokyo Night, Catppuccin, Arch Linux, Gruvbox, Nord, Kanagawa, Wintry, Rose, Cerberus, Catppuccin Latte and Rose Pine Dawn, each with its own wallpaper. -- **Portfolio** - about, portfolio, projects (open source, packages, hackathons, research), blog with RSS and links with QR codes. +- **13 themes** - Cerberus, Flats, Tokyo Night, Night Cat, Catppuccin, Arch Linux, Gruvbox, Nord, Kanagawa, Wintry, Rose, Catppuccin Latte and Rose Pine Dawn, each with its own wallpaper. +- **Portfolio** - about, portfolio, projects (open source, packages, hackathons, research, organizations), blog with RSS and links with QR codes. +- **Live data** - GitHub stars and forks, npm downloads, AniList anime stats and OMDb posters for shows and movies. - **Mobile friendly** - on small screens windows go fullscreen with tabs to switch between them. ## Keybinds @@ -38,6 +41,16 @@ The site recreates my [blomarchy](https://git.sirblob.co/SirBlob/blomarchy) setu Alt stands in for Super, since browsers can't use it. +### Image viewer + +| Keys | Action | +| --- | --- | +| Left / Right | Previous / next image | +| + / - | Zoom in / out | +| 0 | Fit to window | +| R / Shift + R | Rotate right / left | +| Esc | Close viewer | + ## Terminal commands | Command | Does | @@ -61,4 +74,27 @@ bun run dev bun run start ``` +The music player needs `ffmpeg` installed on the server. + +## Configuration + +Copy `.env.example` to `.env` and fill in what you need. Every value is optional. + +| Variable | Used for | +| --- | --- | +| `DISCORD_TOKEN`, `DISCORD_USER_ID`, `DISCORD_GUILD_ID` | Live Discord status in the bar | +| `OMDB_API_KEY` | Posters and details for shows and movies | + +## Content + Site content lives in `content/`. + +| File | Holds | +| --- | --- | +| `profile.json` | Name, bio, socials, skills and photos | +| `about.json` | Hobbies, games, shows, movies and the AniList username | +| `experience.json` / `leadership.json` | Work experience and leadership roles | +| `projects/*.json` | Open source, packages, hackathons, research groups and organizations | +| `music.json` | YouTube links for the music player | +| `desktop.json` | Workspaces, desktop icons and the startup command | +| `blog/*.md` | Blog posts |