countdown/README.md

50 lines
2 KiB
Markdown

# README
[![Release](https://img.shields.io/badge/release-2.4.1-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/countdown/releases)
![Date](https://img.shields.io/badge/date-2023.10.23-c44d58.svg)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.28-137bbb.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/countdown)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/countdown/src/branch/master/LICENSE)
## ABOUT
_countdown_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
> Add widget showing a countdown since/from a predefined date.
## REQUIREMENTS
* Dotclear 2.28
* PHP 8.1
* Dotclear permissions to manage widgets
## USAGE
First install _countdown_, manualy from a zip package or from
Dotaddict repository. (See Dotclear's documentation to know how do this)
Add and configure "Countdown" from widgets manager.
It uses jquery for dynamic countdown.
## LINKS
* [License](https://git.dotclear.watch/JcDenis/countdown/src/branch/master/LICENSE)
* [Packages & details](https://git.dotclear.watch/JcDenis/countdown/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/countdown))
* [Sources & contributions](https://git.dotclear.watch/JcDenis/countdown) (or on [GitHub](https://github.com/JcDenis/countdown))
* [Issues & security](https://git.dotclear.watch/JcDenis/countdown/issues) (or on [GitHub](https://github.com/JcDenis/countdown/issues))
* [Discuss & help](https://forum.dotclear.org/viewforum.php?id=16)
## CONTRIBUTORS
* [Moe](http://gniark.net/) (author)
* Pierre Van Glabeke
* Jean-Christian Denis (latest)
You are welcome to contribute to this code.
## JQUERY PLUGIN
Dynamic display uses plugin jQuery Countdown; See:
* [Plugin](http://keith-wood.name/countdown.html)
* [Formats](http://keith-wood.name/countdownRef.html#format)
* [Display](http://keith-wood.name/countdownRef.html#layout)