improve/README.md

51 lines
1.8 KiB
Markdown

# README
[![Release](https://img.shields.io/github/v/release/JcDenis/improve)](https://github.com/JcDenis/improve/releases)
[![Date](https://img.shields.io/github/release-date/JcDenis/improve)](https://github.com/JcDenis/improve/releases)
[![Issues](https://img.shields.io/github/issues/JcDenis/improve)](https://github.com/JcDenis/improve/issues)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.26-blue.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-green.svg)](https://plugins.dotaddict.org/dc2/details/improve)
[![License](https://img.shields.io/github/license/JcDenis/improve)](https://github.com/JcDenis/improve/blob/master/LICENSE)
## WHAT IS IMPROVE ?
**improve** is a plugin for the open-source
web publishing software called Dotclear.
It helps dev to clean up plugin or theme before publishing code.
* Open to third party plugin
* Easy and fast to use
* Easy and fast to extend
## REQUIREMENTS
**improve** requires:
* admin permission
* Dotclear 2.26-dev
* PHP 8.1+
## USAGE
First install **improve**, manualy from a zip package or from
Dotaddict repository. (See Dotclear's documentation to know how do this)
Manage tools from sidebar plugin menu **improve**.
Configure actions. Select actions and module to work with, then click fix.
Hope some of you have idea to complete function of this plugin
and help devs to maintain their plugins and themes.
## LINKS
* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
* Source & contribution : [GitHub Page](https://github.com/JcDenis/improve)
* Packages & details: [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/improve)
## CONTRIBUTORS
* Jean-Christian Denis
* Gvx
You are welcome to contribute to this code.