cleanup readme file

This commit is contained in:
Jean-Christian Denis 2024-12-31 02:44:04 +01:00
parent 8766c8cc51
commit 93d223b2e0
Signed by: JcDenis
GPG key ID: 1B5B8C5B90B6C951

View file

@ -1,22 +1,20 @@
# README # README
[![Release](https://img.shields.io/badge/release-2.3.1-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/cinecturlink2/releases) [![Release](https://img.shields.io/badge/release-0.1-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/FrontendSession/releases)
![Date](https://img.shields.io/badge/date-2023.11.04-c44d58.svg)] ![Date](https://img.shields.io/badge/date-2024.12.31-c44d58.svg)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.28-137bbb.svg)](https://fr.dotclear.org/download) [![Dotclear](https://img.shields.io/badge/dotclear-v2.33-137bbb.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/cinecturlink2) [![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/FrontendSession)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/cinecturlink2/src/branch/master/LICENSE) [![License](https://img.shields.io/badge/license-GPL--3.0-ececec.svg)](https://git.dotclear.watch/JcDenis/FrontendSession/src/branch/master/LICENSE)
## ABOUT ## ABOUT
_cinecturlink2_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org). _FrontendSession_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
> Widgets and pages about books, musics, films, blogs you are interested in > Allow session on frontend.
It is hightly based on cinecturlink for Dotclear 1 by Tigroux and maintain by brol.
## REQUIREMENTS ## REQUIREMENTS
* Dotclear 2.28 * Dotclear 2.33
* PHP 8.1+ * PHP 8.1+
* Dotclear admin permission for configuration * Dotclear admin permission for configuration
* Dotclear contentadmin permission for management * Dotclear contentadmin permission for management
@ -25,27 +23,26 @@ It is hightly based on cinecturlink for Dotclear 1 by Tigroux and maintain by br
## USAGE ## USAGE
First install _cinecturlink2_, manualy from a zip package or from First install _FrontendSession_, manualy from a zip package or from
Dotaddict repository. (See Dotclear's documentation to know how do this) Dotaddict repository. (See Dotclear's documentation to know how do this)
Go to ''plugins manager'', expand _cinecturlink2_ information then Once it's done you can manage FrontendSession option from from blog preferences.
go to ''configure plugin'', fill in form.
Once it's done you can manage your cinecturlink from menu
''My cinecturlink'' on sidebar or you can add dashboard icon.
There are templates for public page. These template is adapted to There are templates for public page. These template is adapted to
default Dotclear's theme. If you want to create your own template default Dotclear's theme. If you want to create your own template
for your theme, copy files from cinecturlink2/default-templates for your theme, copy files from FrontendSession/default-templates
to your theme tpl path and adapt them. to your theme tpl path and adapt them.
This plugin only manage sign in and session on public pages, nothing more.
Users must exist on Dotclear's database and have rights permissions.
Features enabled by session must be done by others plugins.
## LINKS ## LINKS
* [License](https://git.dotclear.watch/JcDenis/cinecturlink2/src/branch/master/LICENSE) * [License](https://git.dotclear.watch/JcDenis/FrontendSession/src/branch/master/LICENSE)
* [Packages & details](https://git.dotclear.watch/JcDenis/cinecturlink2/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/cinecturlink2)) * [Packages & details](https://git.dotclear.watch/JcDenis/FrontendSession/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/FrontendSession))
* [Sources & contributions](https://git.dotclear.watch/JcDenis/cinecturlink2) (or on [GitHub](https://github.com/JcDenis/cinecturlink2)) * [Sources & contributions](https://git.dotclear.watch/JcDenis/FrontendSession) (or on [GitHub](https://github.com/JcDenis/FrontendSession))
* [Issues & security](https://git.dotclear.watch/JcDenis/cinecturlink2/issues) (or on [GitHub](https://github.com/JcDenis/cinecturlink2/issues)) * [Issues & security](https://git.dotclear.watch/JcDenis/FrontendSession/issues) (or on [GitHub](https://github.com/JcDenis/FrontendSession/issues))
* [Discuss and help](https://forum.dotclear.org/viewtopic.php?id=40893)
## CONTRIBUTORS ## CONTRIBUTORS