From a4fbea790043193bec424bf84defd93bb47b858f Mon Sep 17 00:00:00 2001
From: Banana <mail@bananas-playground.net>
Date: Mon, 15 Jan 2024 14:34:56 +0100
Subject: [PATCH] better readme

---
 README    | 12 ------------
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 12 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index bc3ce25..0000000
--- a/README
+++ /dev/null
@@ -1,12 +0,0 @@
-Insipid is a web-based bookmark manager similar to the Delicious service.
-
-https://www.bananas-playground.net/projekt/insipid/
-
-Documentation can be found in the documentation folder of each release.
-
-Uses:
-https://bulma.io/
-https://github.com/PHPMailer/PHPMailer
-https://ionicons.com/
-https://github.com/druidfi/mysqldump-php
-https://github.com/mikehaertl/php-shellcommand
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a2f07da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# About
+
+Insipid is a self hosted web-based bookmark manager similar to the Delicious service.
+
+Project page: https://www.bananas-playground.net/projekt/insipid/
+
+# Documentation
+
+Documentation can be found in the documentation folder of each release.
+
+# Usage
+
+You install the latest release on a webserver of your own. Add your links, either public or private.
+
+# Contribute
+
+Want to contribute or found a problem?
+
+See Contributing document: [CONTRIBUTING.md](https://github.com/bananas-repos/insipid/blob/master/CONTRIBUTING.md)
+
+# Requirements
+
++ Apache (2.4 and up) with PHP extension enabled
++ PHP (8 and up)
+  - mysql & mysqli
+  - curl
+  - pdo
+  - imap +ssl if you us the email importer
+  - xmlread
+  - xmlwriter
++ MySQL server or access to a database 5.6.x and up
+  - DB user rights has to include create, alter a view
+  - NOT MariaDB. It is missing some functions MySQL has.
+
+Latest browser for accessing the client. IE (not Edge) is not supported anymore.
+
+# Uses
+
++ https://bulma.io/
++ https://github.com/PHPMailer/PHPMailer
++ https://ionicons.com/
++ https://github.com/druidfi/mysqldump-php
++ https://github.com/mikehaertl/php-shellcommand
-- 
2.39.5