Skip to content

Commit 932df40

Browse files
authored
Update README.md
1 parent e984100 commit 932df40

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,26 @@ Show your :heart: - give us a :star: <br/>
1919
Help us grow this project to be the best it can be!
2020
</p>
2121

22-
2322
__VueFront__ is a <a href="//vuejs.org">VueJS powered</a> CMS agnostic SPA & PWA frontend for your old-fashioned Blog and E-commerce site.
2423

2524
__Magento__ empowers thousands of retailers and brands with the best eCommerce platforms and flexible cloud solutions to rapidly innovate and grow.
2625

27-
__CMS Connect App__ - adds the connection between the Magento CMS and VueFront WebApp via a GraphQL API.
26+
__CMS Connect App__ - adds the connection between the Magento CMS and VueFront Web App via a GraphQL API.
27+
28+
# What does it do?
29+
This is a Magento module that connects the Magento CMS with the VueFront Web App via a GraphQL API. When installed, you will be provided with a CMS Connect URL that you will add to your VueFront Web App during [setup](https://vuefront.com/guide/setup.html).
2830

29-
# Demo
31+
## Demo
3032

3133
[VueFront on Magento](https://magento.vuefront.com/)
3234

33-
## How to install & upgrade VueFront
35+
### Magento Blog (Megafan Blog Module)
36+
Since Magento does not have a built-in Blog, we use [Megafan Blog Module](https://marketplace.magento.com/magefan-module-blog.html) to add blog support automatically. If the Megafan Blog Module is not avalible, VueFront will ignore it.
37+
38+
39+
## How to install?
3440

35-
### 1. Install via composer (recommend)
41+
### 1. Quick Install via composer (recommended)
3642

3743
We recommend you to install VueFront module via composer. It is easy to install, update and maintaince.
3844

@@ -60,15 +66,24 @@ Run compile if your store in Product mode:
6066
php bin/magento setup:di:compile
6167
```
6268

63-
### 2. Copy and paste
69+
### 2. Install vie copy/paste
6470

6571
If you don't want to install via composer, you can use this way.
6672

67-
- Download [the latest version here](https://github.com/vuefront/vuefront/archive/master.zip)
73+
- Download [the latest version here](https://github.com/vuefront/magento/archive/master.zip)
6874
- Extract `master.zip` file to `app/code/Vuefront/Vuefront` ; You should create a folder path `app/code/Vuefront/Vuefront` if not exist.
6975
- Go to Magento root folder and run upgrade command line to install `Vuefront`:
7076

7177
```
7278
php bin/magento setup:upgrade
7379
php bin/magento setup:static-content:deploy
7480
```
81+
82+
83+
## Support
84+
For support please contact us at [Discord](https://discord.gg/C9vcTCQ)
85+
86+
## Submit an issue
87+
For submiting an issue, please create one in the [issues tab](https://github.com/vuefront/vuefront/issues). Remember to provide a detailed explanation of your case and a way to reproduce it.
88+
89+
Enjoy!

0 commit comments

Comments
 (0)