kUtRL/README.md

# README

[![Release](https://img.shields.io/github/v/release/JcDenis/kUtRL)](https://github.com/JcDenis/kUtRL/releases)
[![Date](https://img.shields.io/github/release-date/JcDenis/kUtRL)](https://github.com/JcDenis/kUtRL/releases)
[![Issues](https://img.shields.io/github/issues/JcDenis/kUtRL)](https://github.com/JcDenis/kUtRL/issues)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.20-blue.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-green.svg)](https://plugins.dotaddict.org/dc2/details/kUtRL)
[![License](https://img.shields.io/github/license/JcDenis/kUtRL)](https://github.com/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.20

## 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 : [GitHub Page](https://github.com/JcDenis/kUtRL)
 * Packages & details:  [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.