From e15f63ec8dafbd6fb42a6226e24fe8527861af83 Mon Sep 17 00:00:00 2001
From: Evgeny Zinoviev <me@ch1p.io>
Date: Mon, 11 Jul 2022 04:00:24 +0300
Subject: update readme

---
 README | 42 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)

(limited to 'README')

diff --git a/README b/README
index 41d50fa..bb81999 100644
--- a/README
+++ b/README
@@ -1,8 +1,39 @@
 This is complete code of ch1p.io website.
 
+FEATURES
+	- it's not just blog, you can create any page with any address
+	- posts and pages are written in Markdown:
+	 	- supports syntax highlighting in code blocks
+	 	- supports embedding of uploaded files and image resizing
+	 - tags
+	 - rss feed
+	 - dark theme
+	 - ultra fast on backend:
+	 	- written from scratch
+	 	- no heavy frameworks
+	 	- no "classic" template engine
+	 		- vanilla php templates designed from scratch (because why not)
+	 		- thus, no overhead from templates "compilation"
+	 		- all strings are transparently escaped unless explicitly specified not to
+	 - ultra fast on frontend:
+	 	- written from scratch
+	 	- simple readable ECMAScript 5.1 scripts
+	 	- no modern web bullshit like webpack or babel
+	 	- simple build system that just works
+	 - secure:
+	 	- CSRF protection
+	 	- automatic XSS protection in templates
+	 	- see the "BUG BOUNTY" section below
+
 REQUIREMENTS
 
-	PHP >= 8.1 with mysqli or sqlite3, gd
+	- PHP >= 8.1, with following extensions:
+		- mysqli
+		- gd
+	- MariaDB server
+	- Composer
+	- Node.JS
+	- SCSS compiler, e.g. sassc
 
 CONFIGURATION
 
@@ -19,6 +50,15 @@ LOGGING
 
 	TODO
 
+DEPLOYING
+
+	make deploy
+
+BUG BOUNTY
+
+	I take security very seriously. If you found an exploitable vulnerability in _my_ code, please contact me by email.
+	I'm willing to pay $50 to $500 in crypto (depending on severity) for every discovered vulnerability.
+
 LICENSE
 
 	GPLv3
\ No newline at end of file
-- 
cgit v1.2.3