add readme file

master
Jean-Christian Paul Denis 2021-08-26 01:47:00 +02:00
parent d53c4e9a10
commit be0a647da5
1 changed files with 29 additions and 0 deletions

29
README.md 100644
View File

@ -0,0 +1,29 @@
# README
## 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
* Dotclear 2.19
## 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.
## MORE
* License : GNU GPL v2
* Source & contribution : [GitHub Page](https://github.com/JcDenis/kUtRL)
* Packages & details: [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/kUtRL)