krz/hn

A brutalist web client for Hacker News.

clone: git clone https://gitbay.org/krz/hn.git

7f4dbdb90df753dfc9460034a4411467351bf495

unsigned

author: Christian Cleberg <hello@cleberg.net> · 2023-06-01T02:23:59Z

update README.md

 README.md | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index de3700d..969a265 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,27 @@
 # hn
 
 [hn](https://hn.cleberg.net) is a simple front-end alternative for Hacker News. 
-hn focuses on the links shared on Hacker News, currently leaving out an options 
-to login or view comments.
+hn focuses on simplicity and privacy.
+
+## Development
+
+To deploy, ensure you have a publicly-available web server and configure it to 
+fallback with all errors to the `index.php` file rather than returning a `404` 
+error.
+
+For nginx, include the following snippet in your website's conf file:
+
+```conf
+location / {
+        # First attempt to serve request as file, then
+        # as directory then fall back to index.php
+        try_files $uri $uri/ /index.php?$args;
+}
+```
+
+For Apache, you can include the following snippet in a `.htaccess` file within 
+the directory you're serving the PHP file from:
+
+```conf
+FallbackResource /index.php
+```