From be48305bbb17a32eff1442ca047cc1dc3edd9106 Mon Sep 17 00:00:00 2001 From: Gregory Gaskill Date: Sun, 11 Feb 2024 10:31:24 -0500 Subject: [PATCH] Update README --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c146e6..ed35dd7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# SvgIcon plugin for CakePHP 4.x +# SvgIcon plugin for CakePHP 5.x ![Build Status](https://github.com/loadsys/cakephp-svg-icon/actions/workflows/ci.yml/badge.svg?branch=main) @@ -14,6 +14,11 @@ The recommended way to install composer packages is: composer require loadsys/cakephp-svg-icon ``` +## Versions + +* Tags `1.x` are for CakePHP v4.x. +* Tags `2.x` are for CakePHP v5.x. + ## Configuration Icons should be added to `config/app_svg_icon.php` - see the example included in `config` directory for the expected format. Any SVG icon should work, such as [heroicons](https://heroicons.com) or [Bootstrap Icons](https://icons.getbootstrap.com).