From ee909e98c835e24c3c826ce8a5e75561cf4928d4 Mon Sep 17 00:00:00 2001 From: Christian Cleberg Date: Wed, 31 May 2023 21:41:59 -0500 Subject: update README.md --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 969a265..194ffd1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,25 @@ # hn -[hn](https://hn.cleberg.net) is a simple front-end alternative for Hacker News. -hn focuses on simplicity and privacy. +[hn](https://hn.cleberg.net) is a simple front-end alternative for Hacker +News, focusing on privacy and simplicity. + +## TODO + +A scratch pad of ideas that may be useful to implement: + +- [ ] Add functionality to view item-specific page with comments. +- [ ] Add functionality to view a user's profile. +- [ ] Add functionality to load more items or paginate? +- [ ] Add minimal CSS. ## Development +This just uses plain PHP and HTML, no special package managers or development +tools needed. Just start editing the files with your favorite editor and use a +server with PHP if you want to view the results or deploy your own version. + +## Deployment + 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. -- cgit v1.2.3-70-g09d2