Fix docs for the filename option

Fixes #355
sindresorhus · Feb 16, 2019 · ab861ad · ab861ad
1 parent 396912f
commit ab861ad
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/gruntfile.js b/gruntfile.js
@@ -23,6 +23,18 @@ module.exports = grunt => {
 					],
 					dest: 'temp'
 				}
+			},
+			filenameOption: {
+				options: {
+					urls: [
+						'https://sindresorhus.com'
+					],
+					sizes: [
+						'1000x1000'
+					],
+					filename: 'filename-option-{{url}}',
+					dest: 'temp'
+				}
 			}
 		}
 	});

diff --git a/readme.md b/readme.md
@@ -128,8 +128,8 @@ Tip: Go to the website you want a cookie for and [copy-paste it from DevTools](h
 
 Type: `string`
 
-Define a customized filename using [Lo-Dash templates](https://lodash.com/docs#template).<br>
-For example `<%= date %> - <%= url %>-<%= size %><%= crop %>`.
+Define a customized filename using templating.<br>
+For example `{{date}} - {{url}}-{{size}}{{crop}}`.
 
 Available variables:
 

diff --git a/test.js b/test.js
@@ -10,3 +10,7 @@ test('multiple URLs', t => {
 	t.true(pathExists.sync('temp/github.com-1000x1000.png'));
 	t.true(pathExists.sync('temp/google.com-1000x1000.png'));
 });
+
+test('`filename` option', t => {
+	t.true(pathExists.sync('temp/filename-option-sindresorhus.com.png'));
+});