sitemapy - npm Package Compare versions

Comparing version 1.3.0 to 1.4.0

package.json

 {
   "name": "sitemapy",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Simple utility to generate sitemaps in xml, with zero dependencies",
@@ -5,0 +5,0 @@ "main": "dist/sitemapy.js",

README.md

@@ -5,2 +5,72 @@ # Sitemapy
 
-Simple utility to generate sitemaps
+Simple utility to generate sitemaps
+
+## 👀 How to use ?
+
+```sh
+npm i sitemapy
+```
+
+```js
+
+import {createSitemap} from "sitemapy"
+
+const siteRoot = "https://github.com"
+
+let pages = [
+    {
+        url: "/about", //all optional except url
+        priority: 1,
+        changefreq: "daily",
+        lastmod: 10-04-22
+    }
+]
+
+const sitemap = createSitemap({pages, siteRoot}) //returns string of sitemap XML
+
+```
+
+## Typescript
+
+```js
+
+import {createSitemap} from "sitemapy"
+import type {SitemapElement, SitemapConfig} from "sitemapy"
+
+const siteRoot = "https://github.com"
+
+let pages: Array<SitemapElement> = [
+    {
+        url: "/about", //all optional except url
+        priority: 1,
+        changefreq: "daily",
+        lastmod: 10-04-22
+    }
+]
+
+const config: SitemapConfig = {pages, siteRoot}
+
+const sitemap = createSitemap(config) //returns string of sitemap XML
+
+```
+
+## Examples
+
+With express
+
+```js
+
+import axios from "axios"
+import {createSitemap} from "sitemapy"
+
+app.get("/sitemap.xml", async (req, res) => {
+    const siteRoot = "https://github.com"
+    const {data} = await axios.get("/api/sitemapData")
+
+    const sitemap = createSitemap({pages: data, siteRoot})
+
+    res.setHeader('Content-Type', 'application/xml')
+    res.send(sitemap)
+})
+
+```

Fixed alerts

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8639

increased by38.03%

Number of low license alerts

0

decreased by-100%

License quality

100

increased by25%

Number of lines in readme file

75

increased by1400%

No dependency changes