From: Banana <mail@bananas-playground.net>
Date: Mon, 15 Jan 2024 14:07:48 +0000 (+0100)
Subject: better readme
X-Git-Tag: 1.6~9
X-Git-Url: http://91.132.146.200/gitweb/?a=commitdiff_plain;h=a15523cfd774175066722dca445a002e6caf81c4;p=bibliotheca-php.git

better readme
---

diff --git a/README b/README
deleted file mode 100644
index eef9eda..0000000
--- a/README
+++ /dev/null
@@ -1,21 +0,0 @@
-# Bibliotheca
-
-More information and official release visit: https://www.bananas-playground.net/projekt/bibliotheca
-
-## Usage
-Self hosted collection management for movies, music or games.
-Install it on your own webserver (see requirements) and store the information
-about your collected stuff.
-Accessible and usable with a browser. Runs also off a Rapsberry Pi.
-Tag and category support. Fulltext search and individual fields per collection.
-
-See first-steps.txt for first usage steps.
-
-## Technical information
-This is build and tested on a linux based OS. Windows support not yet, but it could work.
-
-## third party
-https://github.com/FabianBeiner/PHP-IMDB-Grabber with some modifications
-https://getuikit.com/
-https://jdan.github.io/98.css/
-https://sortablejs.github.io/Sortable/
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..99e4308
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# Bibliotheca
+
+More information and official release visit: https://www.bananas-playground.net/projekt/bibliotheca
+
+# Usage
+
+Self hosted collection management for movies, music or games.
+Install it on your own webserver (see requirements) and store the information
+about your collected stuff.
+Accessible and usable with a browser. Runs also off a Raspberry Pi.
+Tag and category support. Fulltext search and individual fields per collection.
+
+See first-steps.txt for first usage steps.
+
+# Requirements
+
+See documentation/requirements.txt
+
+# Technical information
+
+This is build and tested on a linux based OS. Windows support not yet, but it could work.
+
+# Contribute
+
+Want to contribute or found a problem?
+
+See Contributing document: CONTRIBUTING.md
+
+# Uses
+
++ https://github.com/FabianBeiner/PHP-IMDB-Grabber with some modifications
++ https://getuikit.com/
++ https://jdan.github.io/98.css/
++ https://sortablejs.github.io/Sortable/