simplyFavicon/README.md

43 lines
1.8 KiB
Markdown

# README
[![Release](https://img.shields.io/badge/release-2023.10.20-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/simplyFavicon/releases)
![Date](https://img.shields.io/badge/date-2023.10.20-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/simplyFavicon)
[![License](https://img.shields.io/github/license/JcDenis/simplyFavicon)](https://git.dotclear.watch/JcDenis/simplyFavicon/blob/master/LICENSE)
## ABOUT
_simplyFavicon_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
> Add a favicon to your blog.
## REQUIREMENTS
* Dotclear 2.28
* PHP 8.1+
* A readable public directory
* Dotclear admin permissions
## USAGE
First install _simplyFavicon_, manualy from a zip package or from
Dotaddict repository. (See Dotclear's documentation to know how do this)
Add un file called ''favicon.xxx'' where xxx could be ico, jpg, png,
on your blog public root directory and
simplyFavicon add required code to public page to show favicon on browser.
## LINKS
* [License](https://git.dotclear.watch/JcDenis/simplyFavicon/src/branch/master/LICENSE)
* [Packages & details](https://git.dotclear.watch/JcDenis/simplyFavicon/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/simplyFavicon))
* [Sources & contributions](https://git.dotclear.watch/JcDenis/simplyFavicon) (or on [GitHub](https://github.com/JcDenis/simplyFavicon))
* [Issues & security](https://git.dotclear.watch/JcDenis/simplyFavicon/issues) (or on [GitHub](https://github.com/JcDenis/simplyFavicon/issues))
## CONTRIBUTORS
* Jean-Christian Denis (author)
You are welcome to contribute to this code.