kUtRL/README.md

44 lines
1.8 KiB
Markdown

# README
[![Release](https://img.shields.io/badge/release-2023.10.19-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/kUtRL/releases)
![Date](https://img.shields.io/badge/date-2023.10.19-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/kUtRL)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/kUtRL/src/branch/master/LICENSE)
## ABOUT
_kUtRL_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
> Use, create and serve short url on your blog
## REQUIREMENTS
* Dotclear 2.28
* PHP 8.1+
* Dotclear admin permission to configure
* No specials permissions to shorten links on the fly
## 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](https://git.dotclear.watch/JcDenis/kUtRL/src/branch/master/LICENSE)
* [Packages & details](https://git.dotclear.watch/JcDenis/kUtRL/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/kUtRL))
* [Sources & contributions](https://git.dotclear.watch/JcDenis/kUtRL) (or on [GitHub](https://github.com/JcDenis/kUtRL))
* [Issues & security](https://git.dotclear.watch/JcDenis/kUtRL/issues) (or on [GitHub](https://github.com/JcDenis/kUtRL/issues))
* [Discussion & Help](http://forum.dotclear.org/viewtopic.php?pid=331158)
## CONTRIBUTORS
* Jean-Christian Denis (author)
* Pierre Van Glabeke
You are welcome to contribute to this code.