📖 DOC: Improve documentation

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+quote_type = single
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = tab
+indent_size = 1
+
+[*.yml]
+indent_style = space
+indent_size = 2

README.md

@@ -1,9 +1,10 @@
 # [![FuzzyMail](https://github.com/luangjokaj/fuzzymail/raw/master/src/assets/img/logo.svg?sanitize=true)](https://www.fuzzymail.co/)
-![Version](https://img.shields.io/github/package-json/v/luangjokaj/fuzzymail) [![Dependencies](https://david-dm.org/luangjokaj/fuzzymail/status.svg)](https://david-dm.org/luangjokaj/fuzzymail)
+
+[![Version](https://img.shields.io/github/package-json/v/luangjokaj/fuzzymail)](https://www.fuzzymail.co/) [![Dependencies](https://img.shields.io/david/luangjokaj/fuzzymail)](https://www.fuzzymail.co/)
 
 | Information | Discord | Donate |
 |:------------|:---------|:-------|
-| [FuzzyMail](https://www.fuzzymail.co/) is Email template generator. Making emails fun again ✌<br><br>**Problem:** Supporting old email clients it's a real pain. I wanted to create something that can be flexible in design and yet support legacy email clients like Outlook.<br><br>**Solution:** FuzzyMail - is a simple tool for generating email templates. Supporting old email clients while maintaining responsiveness. Fuzzymail is supported on over 60+ email clients.| [![Discord server](https://svgshare.com/i/Lqc.svg)](https://discord.gg/qE7e93) | [![BuyMeACoffee](https://www.buymeacoffee.com/assets/img/guidelines/logo-mark-1.svg)](https://www.buymeacoffee.com/luangjokaj) |
+| [FuzzyMail](https://www.fuzzymail.co/) is Email template generator. Making emails fun again ✌<br><br>**Problem:** Supporting old email clients it's a real pain. I wanted to create something that can be flexible in design and yet support legacy email clients like Outlook.<br><br>**Solution:** FuzzyMail - is a simple tool for generating email templates. Supporting old email clients while maintaining responsiveness. Fuzzymail is supported on over 60+ email clients.| [![Discord server](https://svgshare.com/i/Lqc.svg)](https://discord.gg/uQFdMddMZw) | [![BuyMeACoffee](https://www.buymeacoffee.com/assets/img/guidelines/logo-mark-1.svg)](https://www.buymeacoffee.com/luangjokaj) |
 
 [![Preview](https://i.imgur.com/VuKitHE.png)](https://www.fuzzymail.co/)
 Demo Screenshots: [Modern Client](https://i.imgur.com/ETp8PaX.png) • [Gmail](https://i.imgur.com/kSH90xr.png) • [Outlook](https://i.imgur.com/Wi75S1q.png) • [Mobile](https://i.imgur.com/YJgdCJg.png)
@@ -23,7 +24,7 @@ Demo Screenshots: [Modern Client](https://i.imgur.com/ETp8PaX.png) • [Gmail](h
 
 # Documentation
 ### Installation
-FuzzyMail requires Node v7.5+. This is the only global dependency. You can download Node [**here**](https://nodejs.org/).
+FuzzyMail requires **Node.js v12+**. This is the only global dependency. You can download Node.js [**here**](https://nodejs.org/).
 
 ## Setup project
 ### File Structure
@@ -37,32 +38,27 @@ FuzzyMail requires Node v7.5+. This is the only global dependency. You can downl
     │   ├── includes/            # HTML template partials
     │   ├── index.html           # Index page
     └── .gitignore               # Git ignored files
+    └── .editorconfig            # Editor code styles
     └── gulpfile.js              # Gulp configuration
     └── LICENSE                  # License agreements
-    └── package.json             # Node packages
+    └── package.json             # Node.js packages
     └── README.md                # You are reading this
 ```
 
 ## Install FuzzyMail from NPM
-To install FuzzyMail from NPM, run the command:
-```
-sudo npm i fuzzymail -g
-```
-
-**START FUZZYMAIL**
-
 - Create a directory for the new email template and from there run FuzzyMail to generate the file structure:
 ```
-fuzzymail
+npx fuzzymail
 ```
+That's it 🍾 easy as that. Now start the development workflow: [Start Workflow](#start-workflow)
 
 ## Install FuzzyMail from Repository
 Clone repository:
 ```
 git clone https://github.com/luangjokaj/fuzzymail
 ```
 
-- This will clone the repository on your local machine. Navigate to the newly created folder.
+- This will clone the repository on your local machine. Navigate to the newly created directory.
 
 - Replace the file: `./package.json` with `./installer/package.json` and continue with the dependency installation.
 
@@ -72,12 +68,13 @@ git clone https://github.com/luangjokaj/fuzzymail
 npm install
 ```
 
-**START WORKFLOW**
+## Start Workflow
 
-- We are ready to start our development server with the command:
+- To start the development server run the command:
 ```
 npm run dev
 ```
+- You are ready to go! Happy coding! 🤓
 
 ### Templating and HTML Partials
 To avoid repetitive HTML code, FuzzyMail uses [gulp-file-include](https://github.com/haoxins/gulp-file-include). It has a simple templating synthax and allows to re-use chunks of code written in separate files. These partials are located in the directory:
@@ -87,7 +84,6 @@ src/includes/
 
 For more information check out their documentation and examples: https://github.com/haoxins/gulp-file-include 
 
-
 ### Production
 To build the production templates:
 ```

gulpfile.js

@@ -101,7 +101,7 @@ function staticFilesDev() {
 					prefix: '@@',
 					basepath: '@file',
 				},
-			}),
+			})
 		)
 		.pipe(dest('./build'));
 }
@@ -135,13 +135,13 @@ function staticFilesProd() {
 					prefix: '@@',
 					basepath: '@file',
 				},
-			}),
+			})
 		)
 		.pipe(
 			htmlmin({
 				collapseWhitespace: true,
 				ignoreCustomFragments: [/<%[\s\S]*?%>/, /<\?[=|php]?[\s\S]*?\?>/],
-			}),
+			})
 		)
 		.pipe(dest('./dist'));
 }
@@ -153,7 +153,7 @@ function inlineStyles() {
 				applyStyleTags: true,
 				removeStyleTags: false,
 				removeLinkTags: false,
-			}),
+			})
 		)
 		.pipe(dest('./dist'));
 }
@@ -164,7 +164,7 @@ function processImages() {
 		.pipe(
 			imagemin([imagemin.svgo({ plugins: [{ removeViewBox: true }] })], {
 				verbose: true,
-			}),
+			})
 		)
 		.pipe(dest('./dist/assets/img'))
 		.on('end', () => {
@@ -174,12 +174,18 @@ function processImages() {
 		});
 }
 
-exports.prod = series(cleanProd, stylesProd, staticFilesProd, processImages, inlineStyles);
+exports.prod = series(
+	cleanProd,
+	stylesProd,
+	staticFilesProd,
+	processImages,
+	inlineStyles
+);
 
 /* -------------------------------------------------------------------------------------------------
 Utility Tasks
 -------------------------------------------------------------------------------------------------- */
-const onError = err => {
+const onError = (err) => {
 	gutil.beep();
 	gutil.log(fuzzyMail + ' - ' + errorMsg + ' ' + err.toString());
 	this.emit('end');
@@ -189,7 +195,8 @@ const onError = err => {
 Messages
 -------------------------------------------------------------------------------------------------- */
 const errorMsg = '\x1b[41mError\x1b[0m';
-const filesGenerated = 'Your production file are generated in: \x1b[1m' + __dirname + '/dist/ ✅';
+const filesGenerated =
+	'Your production file are generated in: \x1b[1m' + __dirname + '/dist/ ✅';
 
 const fuzzyMail = '\x1b[42m\x1b[1m📨 FuzzyMail\x1b[0m';
 const fuzzyMailUrl = '\x1b[2m - https://www.fuzzymail.co/\x1b[0m';

installer/modules/printNextSteps.js

@@ -29,22 +29,22 @@ module.exports = () => {
 	console.log('\n✊ ', chalk.black.bgYellow(' Support FuzzyMail \n'));
 	console.log('Like FuzzyMail? Check out our other free and open source repositories: \n');
 	console.log(
-		`	${chalk.yellow('WordPressify →')} https://bit.ly/2KTqyQX`,
+		`	${chalk.yellow('WordPressify → ')} https://bit.ly/2KTqyQX`,
 		'\n',
 		`	${chalk.gray('Development workflow for WordPress themes.')}`,
 		'\n',
-		`	${chalk.yellow('GoPablo →')} https://bit.ly/2Hgkfpy`,
+		`	${chalk.yellow('GoPablo → ')} https://bit.ly/2Hgkfpy`,
 		'\n',
 		`	${chalk.gray('GoPablo is a static site generator.')}`,
 		'\n',
-		`	${chalk.yellow('ReactFondue →')} https://bit.ly/2OXgStR`,
+		`	${chalk.yellow('ReactFondue → ')} https://bit.ly/2OXgStR`,
 		'\n',
 		`	${chalk.gray('SEO optimized React applications with SSR.')}`,
 		'\n',
-		`	${chalk.green('Powered by Riangle →')} https://bit.ly/2P5i26I`,
+		`	${chalk.green('Powered by Riangle → ')} https://bit.ly/2P5i26I`,
 		'\n',
 		'\n',
-		`	${chalk.red('Thank you for using 📨 FuzzyMail →')} https://www.fuzzymail.co`,
+		`	${chalk.red('Thank you for using 📨 FuzzyMail → ')} https://www.fuzzymail.co`,
 	);
 
 	// Get started.