From 1cffbc08c13e17f073aff74038d1db46ff3e263e Mon Sep 17 00:00:00 2001 From: Juergen Kunz Date: Fri, 20 Mar 2026 14:09:24 +0000 Subject: [PATCH] fix(readme): format features list as markdown bullets for proper rendering --- changelog.md | 6 ++++++ readme.md | 30 +++++++++++++++--------------- ts/00_commitinfo_data.ts | 2 +- 3 files changed, 22 insertions(+), 16 deletions(-) diff --git a/changelog.md b/changelog.md index 717bbb0..2cdd83e 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,11 @@ # Changelog +## 2026-03-20 - 4.0.1 - fix(readme) +format features list as markdown bullets for proper rendering + +- Converts the features section entries into markdown bullet list items +- Improves README readability and consistent rendering across markdown viewers + ## 2026-03-20 - 4.0.0 - BREAKING CHANGE(api) redesign smartsitemap around builder-based sitemap creation, parsing, validation, and import utilities diff --git a/readme.md b/readme.md index fff644a..8aef527 100644 --- a/readme.md +++ b/readme.md @@ -14,21 +14,21 @@ pnpm install @push.rocks/smartsitemap ## ✨ Features -🔗 **Chainable Builder API** — Fluent, composable API where every method returns `this` -📰 **News Sitemaps** — Google News-compatible with proper namespace handling -🖼️ **Image Sitemaps** — Full `image:image` extension support -🎬 **Video Sitemaps** — Full `video:video` extension with all fields -🌍 **hreflang / i18n** — `xhtml:link` alternate language annotations -📑 **Sitemap Index** — Automatic splitting at 50K URLs with index generation -🌊 **Streaming** — Node.js Readable stream for million-URL sitemaps -✅ **Validation** — URL validation, size limits, spec compliance checks -📊 **Statistics** — URL counts, image/video/news counts, size estimates -📡 **RSS/Atom Feed Import** — Convert feeds to sitemaps (unique feature!) -📄 **YAML Config** — Declarative sitemap definition from YAML -🗂️ **Multi-Format Output** — XML, TXT, JSON, gzipped buffer -🎨 **XSL Stylesheets** — Browser-viewable sitemaps -🔍 **Bidirectional Parsing** — Parse existing sitemaps back into structured data -💪 **Full TypeScript** — Complete type safety with exported interfaces +- 🔗 **Chainable Builder API** — Fluent, composable API where every method returns `this` +- 📰 **News Sitemaps** — Google News-compatible with proper namespace handling +- 🖼️ **Image Sitemaps** — Full `image:image` extension support +- 🎬 **Video Sitemaps** — Full `video:video` extension with all fields +- 🌍 **hreflang / i18n** — `xhtml:link` alternate language annotations +- 📑 **Sitemap Index** — Automatic splitting at 50K URLs with index generation +- 🌊 **Streaming** — Node.js Readable stream for million-URL sitemaps +- ✅ **Validation** — URL validation, size limits, spec compliance checks +- 📊 **Statistics** — URL counts, image/video/news counts, size estimates +- 📡 **RSS/Atom Feed Import** — Convert feeds to sitemaps (unique feature!) +- 📄 **YAML Config** — Declarative sitemap definition from YAML +- 🗂️ **Multi-Format Output** — XML, TXT, JSON, gzipped buffer +- 🎨 **XSL Stylesheets** — Browser-viewable sitemaps +- 🔍 **Bidirectional Parsing** — Parse existing sitemaps back into structured data +- 💪 **Full TypeScript** — Complete type safety with exported interfaces ## Quick Start diff --git a/ts/00_commitinfo_data.ts b/ts/00_commitinfo_data.ts index d248c09..6866bee 100644 --- a/ts/00_commitinfo_data.ts +++ b/ts/00_commitinfo_data.ts @@ -3,6 +3,6 @@ */ export const commitinfo = { name: '@push.rocks/smartsitemap', - version: '4.0.0', + version: '4.0.1', description: 'A comprehensive TypeScript sitemap library with builder API, supporting standard, news, image, video, and hreflang sitemaps with auto-splitting, streaming, validation, and RSS feed integration.' }