From: Banana <mail@bananas-playground.net>
Date: Sat, 26 Apr 2025 08:03:11 +0000 (+0200)
Subject: markdown readme file
X-Git-Url: http://91.132.146.200/gitweb/?a=commitdiff_plain;h=refs%2Fheads%2Fdevelop;p=selfpaste.git

markdown readme file

Signed-off-by: Banana <mail@bananas-playground.net>
---

diff --git a/README b/README
deleted file mode 100644
index 49a9397..0000000
--- a/README
+++ /dev/null
@@ -1,31 +0,0 @@
-selfpaste is a small self hosting paste service.
-https://www.bananas-playground.net/projekt/selfpaste/
-It is not the aim to replace any other well known paste service. 
-It is an experiment and build for private use only.
-
-This tool uses PHP fileinfo: https://www.php.net/manual/en/intro.fileinfo.php
-
-> The functions in this module try to guess the content type and encoding of a file
-> by looking for certain magic byte sequences at specific positions within the file.
-> While this is not a bullet proof approach the heuristics used do a very good job.
-
-It is not really bulletproof, but it does the job. 
-Everything can be manipulated to look alike something it isn't.
-
-So, here is a friendly REMINDER:
-
-    - Use it at own risk.
-    - Don't open it up to the public
-    - Check regularly what is added
-    - Clean everything what you do not know
-    - You provide the service by hosting it. Your are responsible for it!
-    - Change your secret often.
-
-# Why json as a response?
-In cases the upload is over post_max_size the request will not "arrive".
-Meaning the script does not receive enough information to work with.
-In this case it returns the start page. Which is a valid HTTP 200 status response.
-So the client can not only rely on the HTTP status code alone.
-
-# Third party resources
-Link shortening inspired and some code used from: https://www.jwz.org/base64-shortlinks/
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..df413e1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# selfpaste
+
+[selfpaste](https://www.bananas-playground.net/projekt/selfpaste/) is a small self hosting paste service.
+
+It is not the aim to replace any other well known paste service. It is an experiment and build for private use only.
+
+This tool uses PHP [fileinfo](https://www.php.net/manual/en/intro.fileinfo.php)
+
+    The functions in this module try to guess the content type and encoding of a file
+    by looking for certain magic byte sequences at specific positions within the file.
+    While this is not a bullet proof approach the heuristics used do a very good job.
+
+It is **not really bulletproof**, but it does the job.  Everything can be manipulated to look alike something it isn't.
+
+So, here is a friendly REMINDER:
+
+    - Use it at own risk.
+    - Don't open it up to the public
+    - Check regularly what is added
+    - Clean everything what you do not know
+    - You provide the service by hosting it. Your are responsible for it!
+    - Change your secret often.
+
+# Why json as a response?
+
+In cases the upload is over post_max_size the request will not "arrive".
+Meaning the script does not receive enough information to work with.
+In this case it returns the start page. Which is a valid HTTP 200 status response.
+So the client can not only rely on the HTTP status code alone.
+
+# Third party resources
+
+Link shortening inspired and some code used from: https://www.jwz.org/base64-shortlinks/