Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
chronon committed Feb 11, 2024
1 parent 76e4e56 commit be48305
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -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).
Expand Down

0 comments on commit be48305

Please sign in to comment.