Commit ee909e98c8
Unsigned
Layout: unified · split
README.md +17 −2
| @@ -1,10 +1,25 @@ | |||
| 1 | # hn | 1 | # hn |
| 2 | 2 | ||
| 3 | [hn](https://hn.cleberg.net) is a simple front-end alternative for Hacker News. | 3 | [hn](https://hn.cleberg.net) is a simple front-end alternative for Hacker |
| 4 | hn focuses on simplicity and privacy. | 4 | News, focusing on privacy and simplicity. |
| 5 | |||
| 6 | ## TODO | ||
| 7 | |||
| 8 | A scratch pad of ideas that may be useful to implement: | ||
| 9 | |||
| 10 | - [ ] Add functionality to view item-specific page with comments. | ||
| 11 | - [ ] Add functionality to view a user's profile. | ||
| 12 | - [ ] Add functionality to load more items or paginate? | ||
| 13 | - [ ] Add minimal CSS. | ||
| 5 | 14 | ||
| 6 | ## Development | 15 | ## Development |
| 7 | 16 | ||
| 17 | This just uses plain PHP and HTML, no special package managers or development | ||
| 18 | tools needed. Just start editing the files with your favorite editor and use a | ||
| 19 | server with PHP if you want to view the results or deploy your own version. | ||
| 20 | |||
| 21 | ## Deployment | ||
| 22 | |||
| 8 | To deploy, ensure you have a publicly-available web server and configure it to | 23 | To deploy, ensure you have a publicly-available web server and configure it to |
| 9 | fallback with all errors to the `index.php` file rather than returning a `404` | 24 | fallback with all errors to the `index.php` file rather than returning a `404` |
| 10 | error. | 25 | error. |