# README

[![Release](https://img.shields.io/badge/release-2023.08.21-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/kUtRL/releases)
[![Date](https://img.shields.io/badge/date-2023.08.21-c44d58.svg)](https://git.dotclear.watch/JcDenis/kUtRL/releases)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.27-137bbb.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/kUtRL)
[![License](https://img.shields.io/github/license/JcDenis/kUtRL)](https://git.dotclear.watch/JcDenis/kUtRL/blob/master/LICENSE)

## WHAT IS KUTRL ?

_kUtRL_ is a plugin for the open-source 
web publishing software called Dotclear.

Create short URL on its own or from external services.

## REQUIREMENTS

_kUtRL_ requires: 

* admin permission to configure
* no permissions to shorten links on the fly
* Dotclear 2.27
* PHP 8.1+

## USAGE

First install _kUtRL_, manualy from a zip package or from 
Dotaddict repository. (See Dotclear's documentation to know how do this)

Manage settings, services and short URLs from sidebar menu "URL shortener".
You can also add widgets, template block and values.

## LINKS

* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
* Source & contribution : [Gitea Page](https://git.dotclear.watch/JcDenis/kUtRL) or [GitHub Page](https://github.com/JcDenis/kUtRL)
* Packages & details: [Gitea Page](https://git.dotclear.watch/JcDenis/kUtRL/releases) or [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/kUtRL)
* Discussion & Help: [Dotclear Forum](http://forum.dotclear.org/viewtopic.php?pid=331158)

## CONTRIBUTORS

* Jean-Christian Denis
* Pierre Van Glabeke

You are welcome to contribute to this code.