update

README.md

@@ -1,10 +1,14 @@
-<div style="background: #f1e05a; color: black; padding: 12px 24px; border-radius: 6px;">
+<div align="center">
-⚠ This project is new and is under active development. Do not use this in production. Visual designs, logos, assets, and etc are not final. ⚠
+
+<img width="128px" src="https://md.sudovanilla.org/images/logos/butterflyvu/ButterflyVu%20-%20Original.svg"/>
+
 </div>
 
+<br/>
+
 # <center>ButterflyVu</center>
 
-<center>ButterflyVu is a new documentation template built on the Astro Web Framework.</center>
+<center>ButterflyVu is a documentation template built on the Astro Web Framework.</center>
 
 ## Running
 > `bun` will be used over `npm` in instructions.
@@ -13,7 +17,7 @@
  - Bun <span style="font-size: 8px; opacity: 0.5">1</span> <span style="font-size: 8px; opacity: 0.5">2</span>
 
 <p style="font-size: 10px; opacity: 0.5">1. SudoVanilla recommends using the Bun package manager for Astro projects.</p>
-<p style="font-size: 10px; opacity: 0.5">2. If you plan to use Bun, NodeJS is not required to be installed, which is why it's not listed as a requirement. (Tested)</p>
+<p style="font-size: 10px; opacity: 0.5">2. If you plan to use Bun, NodeJS is not required to be installed, which is why it's not listed as a requirement. If you use i18n in Astro, then NodeJS will be required. (Tested)</p>
 
 ### Clone Repository
 Start by cloning the repository to somewhere on your device using the `git` command:
@@ -68,6 +72,24 @@ services:
     volumes:
       - ./dists/:/usr/share/nginx/html/
 ```
+
+## Overriding Components
+
+Since ButterflyVu is written in Astro and the site is built during each startup in Docker, overriding the components is easy. Now for, overriding the header will be shown, it's pretty much the same basics for other components.
+
+> This also works for any other part of ButterflyVu, such as for the layouts and styles. This will be expanded on once the ButterflyVu documentations are written on it's own site, ironic that it hasn't been built yet, right?
+
+### Header
+
+In the `docker-compose.yml` file, add a path to the `volumes` section to your custom header:
+```yml
+  - ./components/Header.astro:/app/src/components/global/Header.astro
+```
+
+The file must be an `.astro` file, anything else like `.jsx` will not work. 
+
+If you already have the custom header written and it's ready for showtime, just run the Docker image again and the new header will be built with the site.
+
 ___
 
 <center>A <a href="https://sudovanilla.org/">SudoVanilla</a> Project</center>

TODO.md

@@ -43,29 +43,5 @@
  - [x] Docker, test with:
     - [x] Dockge
     - [x] Dokemon
- - [ ] Create automations for:
-    - [ ] Drone.io
-    - [ ] Gitea/Forgejo
-    - [ ] GitHub
-    - [ ] GitLab
-    - [ ] Jenkins
-    - [ ] Woodpecker*
- - [ ] Test Deployment Options for:
-    - [ ] Cloudflare Pages
-    - [ ] Codeberg Pages
-    - [ ] Deta Space
-    - [ ] Fly.io
-    - [ ] GitHub Pages
-    - [ ] GitLab Pages
-    - [ ] Heroku
-    - [ ] Kinsta
-    - [ ] Netlify
-    - [ ] Render
-    - [ ] Stormkit
-    - [ ] Surge
-    - [ ] Vercel
-    - [ ] YounoHost
-    - [ ] Zeabur
-    - [ ] Zerops
 
 > * Subject to change