documentation update, bump version

ekalinin · Feb 11, 2021 · f891611 · f891611
1 parent bb011c0
commit f891611
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 6.3.6
+
+- bump dependencies
+
 ## 6.3.5
 
 - Add option to silence or redirect logs from parse #337

diff --git a/README.md b/README.md
@@ -149,7 +149,10 @@ const sms = new SitemapAndIndexStream({
   // for it to write the sitemap urls to and the expected url where that sitemap will be hosted
   getSitemapStream: (i) => {
     const sitemapStream = new SitemapStream({ hostname: 'https://example.com' });
-    const path = `./sitemap-${i}.xml`;
+    // if your server automatically serves sitemap.xml.gz when requesting sitemap.xml leave this line be
+    // otherwise you will need to add .gz here and remove it a couple lines below so that both the index 
+    // and the actual file have a .gz extension
+    const path = `./sitemap-${i}.xml`; 
 
     sitemapStream
       .pipe(createGzip()) // compress the output of the sitemap

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sitemap",
-  "version": "6.3.5",
+  "version": "6.3.6",
   "description": "Sitemap-generating lib/cli",
   "keywords": [
     "sitemap",