Actually decent README

This commit is contained in:
Bingus_Violet 2024-01-26 17:34:51 +00:00
parent 1e533d90c0
commit 16a2768850

View file

@ -1,4 +1,19 @@
# Violets-Purgatory # Violets-Purgatory
This is the source code for the main page of my website, which can be found at <a href="https://violets-purgatory.dev">violets-purgatory.dev</a>. Violet's Purgatory is a website filled to the brim with whatever I feel like adding! Currently, the stable version can be found at https://violets-purgatory.dev and the beta (based on the dev branch) can be found at https://beta.violets-purgatory.dev
Currently, there is no client-side javascript on the main page, and I plan to keep it this way even if it kills me! Although beta probably *isn't* the right term, `dev.violets-purgatory.dev` is just kinda ugly :/
The main web page on the site is dynamically generated. To prevent slow loading times, though, the HTML is generated and outputted into a file when nessacary instead of on request! The website will continiously be actively under development until I die.
I have made sure that as much of the site functions as possible without any modifications from me. The website updates with my Discord information, such as my current activities (games and music), my status, and more.
Currently this is done with the Lanyard API, and as much as I appreciate them for their work, I hope to soon move to a Lanyard instance of our own so that we can spare Phineas (amazing developer of Lanyard) of their resources!
Violet's Purgatory is hosted on Railway right now, but there are plans to move to self-hosting.
We also have an API, which can be located at https://api.violets-purgatory.dev, which is currently very under developed, but will continue to have updates for features I see fit.
## To-do
- [ ] Add image caching instead of using image proxies (keeps the security benefit and decreases loading times)
- [ ] Cut the main CSS file into multiple so that only the nessacary CSS is loaded (Reduces traffic and loading times)
- [ ] Add a commit counter