complete readme file

This commit is contained in:
Jean-Christian Denis 2021-10-30 00:54:24 +02:00
parent d993d20bc6
commit 11dede7f31
Signed by: JcDenis
GPG key ID: 1B5B8C5B90B6C951

View file

@ -1,33 +1,46 @@
# README # README
[![Release](https://img.shields.io/github/v/release/JcDenis/postWidgetText)](https://github.com/JcDenis/postWidgetText/releases)
[![Date](https://img.shields.io/github/release-date/JcDenis/postWidgetText)](https://github.com/JcDenis/postWidgetText/releases)
[![Issues](https://img.shields.io/github/issues/JcDenis/postWidgetText)](https://github.com/JcDenis/postWidgetText/issues)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.19-blue.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-green.svg)](https://plugins.dotaddict.org/dc2/details/postWidgetText)
[![License](https://img.shields.io/github/license/JcDenis/postWidgetText)](https://github.com/JcDenis/postWidgetText/blob/master/LICENSE)
Current git version is a non working version taken from 2013. Current git version is a non working version taken from 2013.
## WHAT IS POSTWIDGETTEXT ? ## WHAT IS POSTWIDGETTEXT ?
"Post widget text" is a plugin for the open-source _Post widget text_ is a plugin for the open-source
web publishing software called Dotclear. web publishing software called Dotclear.
Add a widget related to an entry with custom titles and content. Add a widget related to an entry with custom titles and content.
## REQUIREMENTS ## REQUIREMENTS
postWidgetText requires: _postWidgetText_ requires:
* permissions to manage widgets * permissions to manage widgets
* permissions to manage entries * permissions to manage entries
* Dotclear 2.19 * Dotclear 2.20
## USAGE ## USAGE
First install postWidgetText, manualy from a zip package or from First install _postWidgetText_, manualy from a zip package or from
Dotaddict repository. (See Dotclear's documentation to know how do this) Dotaddict repository. (See Dotclear's documentation to know how do this)
Add and configure "Post widget text" from widgets manager. Add and configure _Post widget text_ from widgets manager.
Manage "widget" related to an entry from entry edition page. Manage "widget" related to an entry from entry edition page.
Manage (delete) "widgets" from sidebar menu called "Post widget text". Manage (delete) "widgets" from sidebar menu called "Post widget text".
## MORE ## LINKS
* License : GNU GPL v2 * License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
* Source & contribution : [GitHub Page](https://github.com/JcDenis/postWidgetText) * Source & contribution : [GitHub Page](https://github.com/JcDenis/postWidgetText)
* Packages & details: [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/postWidgetText) * Packages & details: [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/postWidgetText)
## CONTRIBUTORS
* Jean-Christian Denis
You are welcome to contribute to this code.