From da6dc1501dca8249a816103dff582c5830029541 Mon Sep 17 00:00:00 2001 From: Victor Risgaard <29478339+LalleSX@users.noreply.github.com> Date: Fri, 3 Mar 2023 22:05:05 +0100 Subject: [PATCH] readme --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ccecb66..334984c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # 4chx -A suckless 4chan X inspired user addon, for image boards. GPL \ No newline at end of file +A suckless 4chan X inspired user addon, for image boards. GPL V3. + +## A minimal user addon for 4chan and other like minded imageboards + +Making a minimal style addon for imageboards is a must, as developers come and go on the regular + +No one will really maintain the addon if they either left the site or just don't have the time to maintain it anymore. + +Therefore it's meant to be easily "hackable" for anons to make their own changes/fixes to it + +So if a part breaks then it's not over for the whole project. + +It also combats "bloatware" as each added feature will be made separately, hopefully be one who understands what he is doing so it can be bade as perfect as possible. + +### What will 4chx serve as default? + +These are core features that makes 4chanX, 4chanX + +- Frontend. Header, settings menu, + +- Notifications. Default notification API for errors, information, etc is a valuable core feature. + +- Drop down menu for post. Default will only have 1 or 2 clickable. Will have an API to add buttons to it. +