From 5d2bdd05dab5673ab1fd3fe88a4a7709bb2ac6d8 Mon Sep 17 00:00:00 2001 From: Lim Chee Aun Date: Sat, 10 Jun 2023 19:23:05 +0800 Subject: [PATCH] Document filtered posts implementation --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index cdfdef85..0b822fa3 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,15 @@ Everything is designed and engineered following my taste and vision. This is a p - Limit up to 3 API requests as the root post may be very old or the thread is super long. - If index number couldn't be found, badge will fallback to showing `Thread` without the number. +### Filtered posts + +- "Hide completely"-filtered posts will be hidden, with no UI to reveal it. +- "Hide with a warning"-filtered posts will be partially hidden, showing the filter name and author name. + - Content can be partially revealed by hovering over the post, with tooltip showing the post text. + - Clicking it will open the Post page. + - Long-pressing or right-clicking it will "peek" the post with a bottom sheet UI. + - On boosts carousel, they are not partially hidden, but sorted to the end of the carousel. + ## Development Prerequisites: Node.js 18+