Skip to content

Commit eceae47

Browse files
committed
chore(docs): correct formatting and update log level settings in README
1 parent 7a3e0eb commit eceae47

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ A comprehensive icon management field supporting SVG libraries and icon fonts fo
1515

1616
⚠️ **Beta Features** - The following features are currently in testing and finalization:
1717
- **SVG Sprite support** - Basic functionality implemented, advanced features pending
18-
- **Material Icons** - Core integration complete, variable fonts being refined
18+
- **Material Icons** - Core integration complete, variable fonts being refined
1919
- **Font Awesome** - Free icons working, Pro/Kit support in development
2020

2121
SVG folder icons are fully stable and production-ready.
@@ -81,10 +81,10 @@ return [
8181
'*' => [
8282
// Plugin display name
8383
'pluginName' => 'Icon Manager',
84-
84+
8585
// Default icons path
8686
'iconSetsPath' => '@root/src/icons',
87-
87+
8888
// Icon types to enable
8989
'enabledIconTypes' => [
9090
'svg-folder' => true,
@@ -93,7 +93,7 @@ return [
9393
'material-icons' => false,
9494
],
9595
],
96-
96+
9797
// Dev environment settings
9898
'dev' => [
9999
// Use source icons in dev
@@ -104,7 +104,7 @@ return [
104104
'cacheDuration' => 3600, // 1 hour
105105

106106
// Detailed logging for development
107-
'logLevel' => 'trace',
107+
'logLevel' => 'debug',
108108

109109
// Allow all icon types for testing
110110
'enabledIconTypes' => [
@@ -114,17 +114,17 @@ return [
114114
'material-icons' => true,
115115
],
116116
],
117-
118-
// Staging environment settings
117+
118+
// Staging environment settings
119119
'staging' => [
120120
// Production-ready icons path
121121
'iconSetsPath' => '@webroot/dist/assets/icons',
122-
122+
123123
// Optimize for staging
124124
'enableCache' => true,
125125
'cacheDuration' => 86400, // 1 day
126126
],
127-
127+
128128
// Production environment settings
129129
'production' => [
130130
// Production icons path
@@ -159,7 +159,7 @@ See [Configuration Documentation](docs/CONFIGURATION.md) for all available optio
159159
- **enableCache** - Whether to cache icon data for better performance
160160
- **cacheDuration** - How long to cache icon data, in seconds
161161
- **enabledIconTypes** - Enable/disable specific icon set types
162-
- **logLevel** - Logging verbosity: error, warning, info, or trace
162+
- **logLevel** - Logging verbosity: error, warning, info, or debug
163163

164164
### Creating Icon Sets
165165

@@ -254,18 +254,18 @@ Note: The `|raw` filter is not needed - icons are automatically rendered safely.
254254
{% if icon %}
255255
{# Render with default settings #}
256256
{{ icon.render() }}
257-
257+
258258
{# Render with custom attributes #}
259259
{{ icon.render({
260260
width: 32,
261261
height: 32,
262262
class: 'icon-custom',
263263
'aria-label': 'Star rating'
264264
}) }}
265-
265+
266266
{# Get raw SVG content #}
267267
{{ icon.getContent() }}
268-
268+
269269
{# Access icon properties #}
270270
<div data-icon="{{ icon.name }}" data-set="{{ icon.iconSet.handle }}">
271271
{{ icon.render() }}
@@ -329,15 +329,15 @@ Note: The `|raw` filter is not needed - icons are automatically rendered safely.
329329
# Dimensions
330330
width: 24,
331331
height: 24,
332-
332+
333333
# CSS class
334334
class: 'custom-icon-class',
335-
335+
336336
# Additional attributes
337337
'data-icon': icon.name,
338338
'aria-label': 'Icon description',
339339
'role': 'img',
340-
340+
341341
# Style attribute
342342
style: 'fill: currentColor;'
343343
}) }}
@@ -355,7 +355,7 @@ Add a `metadata.json` file in your icon folders to provide enhanced metadata:
355355
"keywords": ["favorite", "rating", "bookmark"]
356356
},
357357
"heart": {
358-
"keywords": ["love", "like", "favorite"]
358+
"keywords": ["love", "like", "favorite"]
359359
}
360360
}
361361
```
@@ -366,7 +366,7 @@ Add a `metadata.json` file in your icon folders to provide enhanced metadata:
366366
{
367367
"freshly-baked": {
368368
"label": "Freshly Baked",
369-
"labelAr": "مخبوز طازج",
369+
"labelAr": "مخبوز طازج",
370370
"labelEn": "Freshly Baked",
371371
"search": {
372372
"terms": ["fresh", "baked", "bread", "bakery", "طازج", "مخبوز", "خبز"]
@@ -389,7 +389,7 @@ The plugin resolves icon labels in this order:
389389
### Supported Metadata Properties
390390

391391
- **`label`** - Default display label
392-
- **`labelAr`** - Arabic language label
392+
- **`labelAr`** - Arabic language label
393393
- **`labelEn`** - English language label
394394
- **`search.terms`** - Additional search keywords (supports multilingual)
395395
- **`category`** - Icon category for organization
@@ -446,13 +446,13 @@ Icon Manager includes comprehensive logging with configurable levels:
446446
- **Error**: Critical errors only
447447
- **Warning**: Errors and warnings
448448
- **Info**: General information
449-
- **Trace**: Detailed debugging (includes performance metrics)
449+
- **Debug**: Detailed debugging (includes performance metrics)
450450

451451
### Configuration
452452
```php
453453
// config/icon-manager.php
454454
return [
455-
'logLevel' => 'info', // error, warning, info, or trace
455+
'logLevel' => 'info', // error, warning, info, or debug
456456
];
457457
```
458458

@@ -466,7 +466,7 @@ return [
466466
- **Error**: File system failures, SVG parsing errors, database errors
467467
- **Warning**: Missing icons, empty content, slow operations (>1s)
468468
- **Info**: Icon set operations, cache clears, major actions
469-
- **Trace**: Cache hits/misses, performance timing, API requests
469+
- **Debug**: Cache hits/misses, performance timing, API requests
470470

471471
### Log Management
472472
Access logs through the Control Panel:
@@ -521,4 +521,4 @@ This plugin is licensed under the MIT License. See [LICENSE](LICENSE) for detail
521521

522522
---
523523

524-
Developed by [LindemannRock](https://lindemannrock.com)
524+
Developed by [LindemannRock](https://lindemannrock.com)

0 commit comments

Comments
 (0)