feat: refactor and add readme and standardized commands list to justfile along with base eslint config from other projects

2026-03-03 00:19:56 -05:00
parent 516fd0f9ca
commit 203b573168
13 changed files with 386 additions and 51 deletions
@@ -1 +1,42 @@
-# Pretty Borders
+# Pretty Borders
+
+A GNOME Shell extension that adds colorful, animated borders around your active window. The border color smoothly cycles through the hue spectrum, providing visual feedback for window focus.
+
+## Demos
+
+### Color Changing
+![Color Changing Border](attachments/color-changing.gif)
+
+### Selecting Borders
+
+
+## Features
+
+- Dynamic colored border around focused window
+- Smooth color cycling animation
+
+## Roadmap
+- Customizable via preferences (SOON^tm)
+- Static color assignment for active window
+
+## Installation & Setup
+
+Install Pre-reqs
+```bash
+yay -Syu fnm
+```
+
+```bash
+fnm use # sets node version - feel free to use others but this project is fnm first
+npm install pnpm
+just install
+```
+
+## Development
+
+```bash
+just run           # Run GNOME Shell in nested mode for testing your updates
+```
+
+[License](LICENSE.txt)
+