Skip to content

Commit 23b96dd

Browse files
committed
Updated readme file
1 parent 5cc02ad commit 23b96dd

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

.jscsrc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
"preset": "wordpress",
33
"fileExtensions": [ ".js" ],
44
"excludeFiles": [
5-
"assets/js/customizer.js",
6-
"assets/js/admin.min.js",
7-
"assets/js/main.min.js",
8-
"gulpfile.js"
5+
"assets/dist/js/admin.js",
6+
"assets/dist/js/app.js",
7+
"assets/dist/js/gutenberg.js"
8+
"webpack.min.js"
99
]
1010
}

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,13 @@
33
44
[![Build Status](https://travis-ci.org/Alecaddd/awps.svg?branch=master)](https://travis-ci.org/Alecaddd/awps) ![Dependecies](https://david-dm.org/Alecaddd/awps.svg) ![NPM latest](https://img.shields.io/npm/v/npm.svg) ![GPL License](https://img.shields.io/badge/license-GPLv3-blue.svg) [![Code Climate](https://codeclimate.com/github/Alecaddd/awps/badges/gpa.svg)](https://codeclimate.com/github/Alecaddd/awps)
55

6-
## AWPS on YouTube
7-
8-
Introduction and installation video [YouTube](https://www.youtube.com/watch?v=NKRheNMczlM)
9-
106
## Prerequisites
117

128
This theme relies on **NPM** and **Composer** in order to load dependencies and packages.
13-
**Gulp** should always be running and watching during the development process, in order to properly compile and update files.
9+
**Webpack** should always be running and watching during the development process, in order to properly compile and update files.
1410

1511
* Install [Composer](https://getcomposer.org/)
1612
* Install [Node](https://nodejs.org/)
17-
* Install [Gulp](http://gulpjs.com/)
1813

1914

2015
## Installation
@@ -26,17 +21,22 @@ This theme relies on **NPM** and **Composer** in order to load dependencies and
2621
* Execute `npm install`
2722

2823

29-
## Gulp
24+
## Webpack
25+
26+
AWPS uses [Laravel Mix](https://laravel.com/docs/5.6/mix) for assets management. Check the official documentation for advanced options
3027

31-
* Run `gulp watch` at the beginning of every development session
32-
* Run `gulp` to quickly compile without watching
33-
* Run `gulp --production` to compile the assets for production and remove debug and console messages
28+
* Edit the `webpack.mix.js` in the root directory of your theme to set your localhost URL and customize your assets
29+
* `npm run watch` to start browserSync with LiveReload and proxy to your custom URL
30+
* `npm run dev` to quickly compile and bundle all the assets without watching
31+
* `npm run prod` to compile the assets for production
3432

3533

3634
## Features
3735

38-
* Bult-in `gulpfile.js` for fast development and compiling.
36+
* Bult-in `webpack.mix.js` for fast development and compiling.
3937
* `OOP` PHP, and `namespaces` with `PSR4` autoload.
38+
* `Customizer` ready with boilerplate and example classes.
39+
* `Gutenberg` ready with boilerplate and example blocks.
4040
* `ES6 Javascript` syntax ready.
4141
* Compatible with `JetPack`, `WooCommerce`, `ACF PRO`, and all the most famous plugins.
4242
* Built-in `FlexBox` Responsive Grid.

0 commit comments

Comments
 (0)