Add screenshot to readme.md

CodeParrots · Feb 18, 2018 · 3aff771 · 3aff771
1 parent c83c725
commit 3aff771
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -200,6 +200,13 @@ module.exports = function(grunt) {
 
 					}
 
+					// Screenshots
+					if ( grunt.file.exists( 'github-assets/screenshot-1.png' ) ) {
+
+						readme = readme.replace( '## Install Instructions ##', "## Screenshots ##\r\n\r\n![Screenshot 1](github-assets/screenshot-1.png)\r\n\r\n## Install Instructions ##" );
+
+					}
+
 					// Tag links
 					readme = readme.replace( matches[0], section );
 

diff --git a/README.md b/README.md
@@ -39,6 +39,10 @@ Example: `wp-content/uploads/webp/`
 
 On the front end of your site, if a `.webp` format is available for the media element than the `.webp` format will be served. If not, or if a browser doesn't support `.webp` formats - then the original image will be served to the browser.
 
+## Screenshots ##
+
+![Screenshot 1](github-assets/screenshot-1.png)
+
 ## Install Instructions ##
 
 1. Install cwebp - https://developers.google.com/speed/webp/docs/cwebp

diff --git a/github-assets/screenshot-1.png b/github-assets/screenshot-1.png