feature(CannonicalURL) rkazakov#22 Update readme with documentation

blanxii · Oct 1, 2018 · 7d7a5a5 · 7d7a5a5
1 parent c6ee133
commit 7d7a5a5
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ npm install ampify --save
 ```js
 const ampify = require('ampify');
 const html = '<YOUR_HTML_CONTENT>';
-const amp = ampify(html, {cwd: 'amp'});
+const amp = ampify(html, {cwd: 'amp'}, 'https://<your-canoncial-url>');
 console.log(amp); // Content of AMP HTML
 ```
 
@@ -36,6 +36,9 @@ console.log(amp); // Content of AMP HTML
 
 ### round
 
+## Canonical URL
+With the third parameter you can set the Cannonical URL, should be a full valid URL, please refer to [page discoverable](https://www.ampproject.org/docs/fundamentals/discovery)
+
 ### Enable images dimensions rounding
 
 - Type: `String`