From b2deebd188c8b3ebd389dc0e7ad0e942c1412d49 Mon Sep 17 00:00:00 2001
From: Jean-Christian Denis <contact@jcdenis.fr>
Date: Tue, 7 Sep 2021 00:01:53 +0200
Subject: [PATCH] Fix readme file

---
 CHANGELOG.md |  2 +-
 README.md    | 40 +++++++++++++++++++++++++++++++++++++++-
 2 files changed, 40 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 58d407b..ae92756 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,7 +7,7 @@
 - [ ] fix PSR(1)2 coding style
 - [ ] fix translation
 - [ ] update license
-- [ ] update readme
+- [x] update readme
 
 0.7.3 - 2018.03.12 - Pierre Van Glabeke
 - pb image liée au plugin informations
diff --git a/README.md b/README.md
index 6b0ad8d..9fcb53c 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,39 @@
-# dcAdvancedCleaner
\ No newline at end of file
+# README
+
+## WHAT IS DCADVANCEDCLEANER ?
+
+_dcAdvancedCleaner_ is a plugin for the open-source 
+web publishing software called Dotclear.
+
+It help clean up Dotclear install, plugins, themes, 
+settings, tables, cache, etc...
+
+## REQUIREMENTS
+
+ _dcAdvancedCleaner_ requires: 
+
+  * Permissions superadmin
+  * Dotclear 2.19 
+
+## USAGE
+
+First install _dcAdvancedCleaner_, manualy from a zip package or from 
+Dotaddict repository. (See Dotclear's documentation to know how do this)
+
+Go to ''plugins manager'', expand _dcAdvancedCleaner_ information then 
+go to ''configure plugin'', fill in form.
+
+Once it's done you can manage your reports from menu 
+''Advanced cleaner'' on sidebar or you can add dashboard icon.
+
+## MORE
+
+ * License : GNU GPL v2
+ * Source & contribution : [GitHub Page](https://github.com/JcDenis/dcAdvancedCleaner)
+ * Packages & details:  [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/dcAdvancedCleaner)
+ * Discuss and help : [Dotclear Forum](https://forum.dotclear.org/viewtopic.php?id=40381)
+ 
+## CONTRIBUTORS
+
+ * Jean-Christian Denis
+ * Pierre Van Glabeke
\ No newline at end of file