Skip to content

Commit 354adaa

Browse files
authored
Update README.md
1 parent 4cfd25b commit 354adaa

File tree

1 file changed

+30
-17
lines changed

1 file changed

+30
-17
lines changed

README.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
This module adds an easy and efficient way to integrate a comprehensive FAQ section into your Magento store using a jQuery Accordion layout. It allows the admin to create and manage FAQs and organize them into groups, each with its own icon for better visual distinction. With a rich WYSIWYG editor, admins can enhance FAQ answers by adding widgets, static blocks, images, and more. The module streamlines customer support by making key information easily accessible in a user-friendly and interactive format.
1212

13-
# Features
13+
# Features
1414

1515
- Display all FAQs or FAQs by group on CMS pages and static blocks
1616
- Enable AJAX-based FAQ loading on group selection for a seamless frontend experience
@@ -29,24 +29,37 @@ This module adds an easy and efficient way to integrate a comprehensive FAQ sect
2929

3030
<b>Check full description and user guid on <a href="https://commercemarketplace.adobe.com/mageprince-module-faq.html">Magento Marketplace</a></b>
3131

32-
# Demo
32+
# 📺 Demo
3333

3434
<b><a href="https://demo.mageprince.com/faq/">Frontend</a> | <a href="https://demo.mageprince.com/admin">Backend</a></b>
3535

36-
# How to install
36+
# 🚀 Installation Instructions
3737

3838
### 1. Install from Magento Marketplace
3939

4040
[Magento Marketplace Link](https://commercemarketplace.adobe.com/mageprince-module-faq.html)
4141

4242
### 2. Install via composer (packagist.org)
4343

44-
Run the following command in the Magento 2 root folder:
44+
Run the following Magento CLI commands:
4545

46-
composer require mageprince/module-faq
47-
php bin/magento setup:upgrade
48-
php bin/magento setup:di:compile
49-
php bin/magento setup:static-content:deploy
46+
```
47+
composer require mageprince/module-faq
48+
php bin/magento setup:upgrade
49+
php bin/magento setup:di:compile
50+
php bin/magento setup:static-content:deploy
51+
```
52+
53+
### 3. Manual Installation
54+
55+
Copy the content of the repo to the Magento 2 `app/code/Mageprince/Paymentfee`
56+
57+
Run the following Magento CLI commands:
58+
```
59+
php bin/magento setup:upgrade
60+
php bin/magento setup:di:compile
61+
php bin/magento setup:static-content:deploy
62+
```
5063

5164
# GraphQL
5265

@@ -103,24 +116,24 @@ Run the following command in the Magento 2 root folder:
103116
# How to Display FAQs in CMS Pages or Static Blocks
104117

105118
<b>1. To show all FAQ</b>
106-
107-
<code>{{block class="Mageprince\Faq\Block\Index\Index" template="Mageprince_Faq::faq_main.phtml" show_group_title=1 show_group=1 page_type="scroll"}}</code>
108-
119+
```
120+
{{block class="Mageprince\Faq\Block\Index\Index" template="Mageprince_Faq::faq_main.phtml" show_group_title=1 show_group=1 page_type="scroll"}}
121+
```
109122
<b>2. To show FAQ by group</b>
123+
```
124+
{{block class="Mageprince\Faq\Block\Index\Index" template="Mageprince_Faq::faq_main.phtml" group_id=1 show_group_title=1}}
125+
```
110126

111-
<code>{{block class="Mageprince\Faq\Block\Index\Index" template="Mageprince_Faq::faq_main.phtml" group_id=1 show_group_title=1}}</code>
112-
113-
114-
# Contribution
127+
# 🤝 Contribution
115128

116129
Want to contribute to this extension? The quickest way is to <a href="https://help.github.com/articles/about-pull-requests/">open a pull request</a> on GitHub.
117130

118-
# Support
131+
# 🛠 Support
119132

120133
If you encounter any problems or bugs, please <a href="https://github.com/mageprince/magento2-FAQ/issues">open an issue</a> on GitHub.
121134

122135

123-
# Extension Screenshots
136+
# 📸 Screenshots
124137

125138
![1_faq_page](https://github.com/user-attachments/assets/c041d098-fea4-4cd4-aeb8-8907f6612554)
126139
![3_widget](https://github.com/user-attachments/assets/909d8260-2f77-42e5-ad11-8c4a2d355e34)

0 commit comments

Comments
 (0)