activityReport/README.md

46 lines
1.9 KiB
Markdown

# README
[![Release](https://img.shields.io/badge/release-3.3-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/activityReport/releases)
![Date](https://img.shields.io/badge/date-2023.08.17-c44d58.svg)
[![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/activityReport)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/activityReport/blob/master/LICENSE)
## ABOUT
_activityReport_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
> Log and receive your blog activity by email, feed, or on dashboard
## REQUIREMENTS
* Dotclear 2.27
* PHP 8.1+
* System permissions to add table on database
* System permissions to send email
* Dotclear admin permissions
## USAGE
First install _activityReport_, manualy from a zip package or from
Dotaddict repository. (See Dotclear's documentation to know how do this)
Go to ''plugins manager'', expand _activityReport_ information then
go to ''configure plugin'', fill in form.
Once it's done you can manage your reports from menu
''Activity report'' on sidebar or you can add dashboard icon.
## LINKS
* [License](https://git.dotclear.watch/JcDenis/activityReport/blob/master/LICENSE)
* [Packages & details](https://git.dotclear.watch/JcDenis/activityReport/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/activityReport))
* [Sources & contributions](https://git.dotclear.watch/JcDenis/activityReport) (or on [GitHub](https://github.com/JcDenis/activityReport))
* [Issues & security](https://git.dotclear.watch/JcDenis/activityReport/issues) (or on [GitHub](https://github.com/JcDenis/activityReport/issues))
## CONTRIBUTORS
* Jean-Christian Denis (author)
You are welcome to contribute to this code.