Skip to content

Commit a4bf875

Browse files
committed
Update Templated README
1 parent e2f6440 commit a4bf875

1 file changed

Lines changed: 16 additions & 11 deletions

File tree

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,33 @@
44

55
</div>
66

7-
<h1 align="center">element119 | Module Name</h1>
7+
<h1 align="center">element119 | CMS Identifier Markup</h1>
88

99
<div align="center">
1010

11-
![github release](https://img.shields.io/github/v/release/pykettk/module-name?color=ffbf00&label=version)
12-
![github release date](https://img.shields.io/github/release-date/pykettk/module-name?color=8b32a8&label=last%20release)
11+
![github release](https://img.shields.io/github/v/release/pykettk/module-cms-identifier-markup?color=ffbf00&label=version)
12+
![github release date](https://img.shields.io/github/release-date/pykettk/module-cms-identifier-markup?color=8b32a8&label=last%20release)
1313
![magento](https://img.shields.io/badge/Magento-^2.4.4-ec6611.svg)
1414
![license](https://img.shields.io/badge/license-OSL-ff00dd.svg)
15-
![packagist downloads](https://img.shields.io/packagist/dt/element119/module-name?color=ff0000)
15+
![packagist downloads](https://img.shields.io/packagist/dt/element119/module-cms-identifier-markup?color=ff0000)
1616

1717
</div>
1818

1919
---
2020

2121
## 📝 Features
22-
✔️ ...
22+
✔️ Adds an additional HTML `data-` attribute to CMS blocks for ease of identification
2323

24-
✔️ ...
24+
✔️ Additional markup is added automatically, no manual intervention from admins required
2525

26-
✔️ ...
26+
✔️ Configurable `data-` attribute name to avoid conflicts with other customisations
2727

2828
<br/>
2929

3030
## 🔌 Installation
3131
Run the following command to *install* this module:
3232
```bash
33-
composer require element119/module-name
33+
composer require element119/module-cms-identifier-markup
3434
php bin/magento setup:upgrade
3535
```
3636

@@ -39,7 +39,7 @@ php bin/magento setup:upgrade
3939
## ⏫ Updating
4040
Run the following command to *update* this module:
4141
```bash
42-
composer update element119/module-name
42+
composer update element119/module-cms-identifier-markup
4343
php bin/magento setup:upgrade
4444
```
4545

@@ -48,14 +48,19 @@ php bin/magento setup:upgrade
4848
## ❌ Uninstallation
4949
Run the following command to *uninstall* this module:
5050
```bash
51-
composer remove element119/module-name
51+
composer remove element119/module-cms-identifier-markup
5252
php bin/magento setup:upgrade
5353
```
5454

5555
<br/>
5656

5757
## 📚 User Guide
58-
...
58+
Module configuration can be found under `Stores -> Settings -> Configuration -> General -> Content Management -> Advanced Content Tools`.
59+
60+
`Add CMS Block Identifier to Markup` toggles this module's functionality on and off. When this option is set to `Yes`,
61+
the custom HTML `data-` attribute that contains the CMS block's identifier will be added to the markup.
62+
63+
`CMS Block Identifier HTML data- Attribute Name` sets the name of the custom HTML `data-` attribute.
5964

6065
<br>
6166

0 commit comments

Comments
 (0)