small readme tweaks (#81)
Some checks are pending
Run unit tests / run-unit-tests (push) Waiting to run

Reviewed-on: https://gitea.subcultureofone.org/greg/tkr/pulls/81
Co-authored-by: Greg Sarjeant <greg@subcultureofone.org>
Co-committed-by: Greg Sarjeant <greg@subcultureofone.org>
This commit is contained in:
Greg Sarjeant 2025-08-28 12:57:19 +00:00 committed by greg
parent 66f40e5e97
commit ba09f06a86

View File

@ -6,7 +6,7 @@ A simple, HTML-only status feed for self-hosted personal websites. Written in PH
## LLM Disclosure ## LLM Disclosure
I used Claude for guidance on some portions of this. I limited it to things that I couldn't find good answers to otherwise, and I used it as a learning tool. I've adapted any LLM-generated code suggestions, but if you strongly object to LLMs and don't want any LLM-assisted code on your site, then you shouldn't use this. I used Claude for guidance on some portions of tkr. I've adapted any LLM-generated code suggestions, but if you strongly object to LLMs and don't want any LLM-assisted code on your site, then you shouldn't use this.
## Requirements ## Requirements
@ -46,10 +46,10 @@ I used Claude for guidance on some portions of this. I limited it to things that
* apache shared hosting (e.g. everything served from `public_html`, .htaccess only) * apache shared hosting (e.g. everything served from `public_html`, .htaccess only)
* apache VPS * apache VPS
* subfolder: e.g. https://example.com/tkr * subfolder: e.g. https://example.com/tkr
* subdomain: e.g. https://tke.example.com * subdomain: e.g. https://tkr.example.com
* nginx VPS * nginx VPS
* subfolder: e.g. https://example.com/tkr * subfolder: e.g. https://example.com/tkr
* subdomain: e.g. https://tke.example.com * subdomain: e.g. https://tkr.example.com
* Expose only the `public` folder if possible * Expose only the `public` folder if possible
* The VPS examples are configured this way. * The VPS examples are configured this way.
* If this isn't possible (e.g. shared hosting), it's okay. There are `.htaccess` files included to block access to other directories in shared hosting environments. * If this isn't possible (e.g. shared hosting), it's okay. There are `.htaccess` files included to block access to other directories in shared hosting environments.