Update some badges in README

[jirafeau.git] / README.md

diff --git a/README.md b/README.md
index 4a243a240f5ddd0b70d0a95dcf5bf3d75f849aa0..cbb5f8a2af55ca93866fb85219c6997bc8851e6e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,13 @@
+# DISCLAMER
+
+The project is not maintained anymore. See [announcement](https://gitlab.com/mojo42/Jirafeau/-/issues/360).
+
+If you are forking the project, feel free to mention it in [comments](https://gitlab.com/mojo42/Jirafeau/-/issues/360). I will add it here.
+

 # Jirafeau
 
 # Jirafeau
 

-![Build Status](https://img.shields.io/gitlab/pipeline/mojo42/Jirafeau/master.svg)

 ![Made With](https://img.shields.io/badge/made_with-php-blue.svg)
 ![License](https://img.shields.io/badge/license-agpl--3.0-blue.svg)
 ![Made With](https://img.shields.io/badge/made_with-php-blue.svg)
 ![License](https://img.shields.io/badge/license-agpl--3.0-blue.svg)

-![Contribution](https://img.shields.io/badge/contributions_welcome-brightgreen.svg?labelColor=brightgreen)

 
 Welcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/Open-source_software).
 
 
 Welcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/Open-source_software).
 


@@ -273,7 +277,7 @@ Check [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and
 
 ### What about this file deduplication thing?
 
 
 ### What about this file deduplication thing?
 

-Jirafeau uses a very simple file level deduplication for storage optimization.
+Jirafeau can use a very simple file level deduplication for storage optimization.

 
 This mean that if some people upload several times the same file, this will only store one time the file and increment a counter.
 
 
 This mean that if some people upload several times the same file, this will only store one time the file and increment a counter.
 


@@ -283,9 +287,11 @@ When the counter falls to zero, the file is destroyed.
 
 In order to know if a newly uploaded file already exist, Jirafeau will hash the file using md5 by default but other methods are available (see `file_hash` documentation in `lib/config.original.php`).
 
 
 In order to know if a newly uploaded file already exist, Jirafeau will hash the file using md5 by default but other methods are available (see `file_hash` documentation in `lib/config.original.php`).
 

+This feature is disabled by default and can be enabled through the `file_hash` option.
+

 ### What is the difference between "delete link" and "delete file and links" in admin interface?
 
 ### What is the difference between "delete link" and "delete file and links" in admin interface?
 

-As explained in the previous question, files with the same hash are not duplicated and a reference counter stores the number of links pointing to a single file.
+When file deduplication feature is enabled, files with the same hash are not duplicated and a reference counter stores the number of links pointing to a single file.

 So:
 - The button "delete link" will delete the reference to the file but might not destroy the file.
 - The button "delete file and links" will delete all references pointing to the file and will destroy the file.
 So:
 - The button "delete link" will delete the reference to the file but might not destroy the file.
 - The button "delete file and links" will delete all references pointing to the file and will destroy the file.


@@ -294,6 +300,8 @@ So:
 
 Feel free to create an issue if you found a bug.
 
 
 Feel free to create an issue if you found a bug.
 

+Also, you can come have a chat on [libera.chat](https://web.libera.chat/) in `#jirafeau` channel.
+

 ### Can I buy you a coffee?
 
 You can [drop few bucks](https://www.paypal.com/paypalme/jeromejutteau) to help the [demo web site](https://jirafeau.net) to stay alive.
 ### Can I buy you a coffee?
 
 You can [drop few bucks](https://www.paypal.com/paypalme/jeromejutteau) to help the [demo web site](https://jirafeau.net) to stay alive.