From be0a647da51662ff9cd1b65b289c8ab53f10be87 Mon Sep 17 00:00:00 2001 From: Jean-Christian Denis Date: Thu, 26 Aug 2021 01:47:00 +0200 Subject: [PATCH] add readme file --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..490abe6 --- /dev/null +++ b/README.md @@ -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) \ No newline at end of file