From b41afca053c22f8a2511e867d4246af38860045d Mon Sep 17 00:00:00 2001
From: Justin Deal <justindeal@protonmail.com>
Date: Sat, 3 May 2025 02:44:08 -0700
Subject: [PATCH] update readme
---
README.md | 47 ++++++++++++++++++-
src/lib/types.ts | 4 +-
src/lib/variables.ts | 4 +-
.../{html-intro.md => jellyfin-at-home.md} | 2 +-
src/pages/index.astro | 4 +-
.../projects/{zaggonaut.md => this-site.md} | 6 ++-
6 files changed, 57 insertions(+), 10 deletions(-)
rename src/pages/blog/{html-intro.md => jellyfin-at-home.md} (99%)
rename src/pages/projects/{zaggonaut.md => this-site.md} (92%)
diff --git a/README.md b/README.md
index 687398c..9ac2ae1 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,48 @@
# justin.deal
-My personal website and blog.
+A personal website featuring a blog, project portfolio, and homelab dashboard.
-Visit the site at https://justin.deal
\ No newline at end of file
+## About
+
+This site serves as my digital home on the web, built with modern web technologies and a focus on performance, accessibility, and user experience.
+
+- **Visit**: [https://justin.deal](https://justin.deal)
+- **Built with**: Astro, TypeScript, TailwindCSS, and Alpine.js
+
+## Key Features
+
+### Content
+- Blog with searchable posts and tag filtering
+- Project portfolio with detailed case studies
+- Homelab dashboard for self-hosted services
+- Dark/light mode with Gruvbox-inspired theme
+
+### Technical
+- Component-based architecture
+- Responsive design for all devices
+- Advanced search with keyboard navigation
+- Optimized loading with skeleton states
+- Accessibility-first approach
+
+## Quick Start
+
+```bash
+# Install dependencies
+pnpm install
+
+# Development server
+pnpm dev
+
+# Production build
+pnpm build
+```
+
+## Adding Content
+
+- **Blog**: Create markdown files in `src/pages/blog/`
+- **Projects**: Add project details in `src/pages/projects/`
+- **Homelab**: Update services in `src/pages/homelab/services.ts`
+
+## License
+
+MIT
diff --git a/src/lib/types.ts b/src/lib/types.ts
index 7ab9697..1f9c898 100644
--- a/src/lib/types.ts
+++ b/src/lib/types.ts
@@ -38,7 +38,7 @@ export type ProjectFrontmatter = {
/**
* The URL of the project on the website
- * (eg. https://zaggonaut.dev/projects/my-project)
+ * (eg. https://justin.deal/projects/my-project)
*/
filename: string;
};
@@ -77,7 +77,7 @@ export type ArticleFrontmatter = {
/**
* The URL of the article on the website
- * (eg. https://zaggonaut.dev/blog/my-article)
+ * (eg. https://justin.deal/blog/my-article)
*/
filename: string;
};
diff --git a/src/lib/variables.ts b/src/lib/variables.ts
index 3c13d4e..e2e6db4 100644
--- a/src/lib/variables.ts
+++ b/src/lib/variables.ts
@@ -5,10 +5,10 @@ export const GLOBAL = {
username: "Justin Deal",
rootUrl: "https://justin.deal",
shortDescription: "My personal slice of the internet",
- longDescription: "Zaggonaut is a retro-inspired theme for Astro, built using TypeScript, TailwindCSS, and Astro.",
+ longDescription: "My personal blog, portfolio, and homelab dashboard built with Astro, TypeScript, TailwindCSS, and Alpine.js.",
// Social media links
- githubProfile: "https://github.com/RATIU5/zaggonaut",
+ githubProfile: "https://github.com/justindeal",
twitterProfile: "https://twitter.com/",
linkedinProfile: "https://www.linkedin.com/",
diff --git a/src/pages/blog/html-intro.md b/src/pages/blog/jellyfin-at-home.md
similarity index 99%
rename from src/pages/blog/html-intro.md
rename to src/pages/blog/jellyfin-at-home.md
index b23c952..57976e2 100644
--- a/src/pages/blog/html-intro.md
+++ b/src/pages/blog/jellyfin-at-home.md
@@ -6,7 +6,7 @@ tags: ["code", "html", "homelab"]
time: 4
featured: true
timestamp: 2024-12-18T02:39:03+00:00
-filename: html-intro
+filename: jellyfin-at-home
---
## The Beginning of an Obsession
diff --git a/src/pages/index.astro b/src/pages/index.astro
index 2533278..3a78a74 100644
--- a/src/pages/index.astro
+++ b/src/pages/index.astro
@@ -23,7 +23,7 @@ import FeaturedArticles from "../components/home/FeaturedArticles.astro";
property="og:description"
content={GLOBAL.longDescription}
/>
- <meta property="og:image" content={`${GLOBAL.rootUrl}/zaggonaut.png`} />
+ <meta property="og:image" content={`${GLOBAL.rootUrl}/${GLOBAL.profileImage}`} />
<meta property="og:url" content={GLOBAL.rootUrl} />
<meta name="twitter:card" content="summary_large_image" />
<meta
@@ -34,7 +34,7 @@ import FeaturedArticles from "../components/home/FeaturedArticles.astro";
name="twitter:description"
content={GLOBAL.longDescription}
/>
- <meta name="twitter:image" content={`${GLOBAL.rootUrl}/zaggonaut.png`} />
+ <meta name="twitter:image" content={`${GLOBAL.rootUrl}/${GLOBAL.profileImage}`} />
<meta http-equiv="content-language" content="en" />
<meta name="language" content="English" />
<link rel="canonical" href={GLOBAL.rootUrl} />
diff --git a/src/pages/projects/zaggonaut.md b/src/pages/projects/this-site.md
similarity index 92%
rename from src/pages/projects/zaggonaut.md
rename to src/pages/projects/this-site.md
index 009d076..ca0daeb 100644
--- a/src/pages/projects/zaggonaut.md
+++ b/src/pages/projects/this-site.md
@@ -6,7 +6,7 @@ tags: ["astro", "typescript", "tailwindcss", "alpinejs", "responsive-design", "a
githubUrl: https://code.justin.deal
timestamp: 2025-02-24T02:39:03+00:00
featured: true
-filename: zaggonaut
+filename: this-site
---
## The Details
@@ -67,3 +67,7 @@ The architecture follows a component-based approach with a focus on reusability
- **Interactivity**: Alpine.js
- **Build Tools**: Vite, npm/pnpm
- **Deployment**: Self-hosted
+
+## The Future
+
+Future enhancements will include expanded blog functionality, integration with more homelab services, and additional interactive features. The component library will continue to grow with new UI elements and patterns.