Skip to content

Commit 6b87e4e

Browse files
docs: Update punctuation
1 parent 08e203b commit 6b87e4e

2 files changed

Lines changed: 13 additions & 25 deletions

File tree

README.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ Feedsmith maintains the original feed structure in a clean, object-oriented form
2424

2525
#### Leniency
2626
* **Normalizes legacy elements** ✨ — Upgrades feed elements to their modern equivalents so that you never need to worry about reading feeds in older formats.
27-
* **CaSe INSENsiTive** — Handles JSON properties and XML tags in any case (lowercase, uppercase, mixed).
27+
* **CaSe INSENsiTive** — Handles fields and attributes in any case (lowercase, uppercase, mixed).
2828

2929
#### Performance and type-safety
30-
* **Fast parsing**Built on fast-xml-parser, it's one of the fastest feed parsers in JavaScript (see [benchmarks](#benchmarks)).
30+
* **Fast parsing**One of the fastest feed parsers in JavaScript (see [benchmarks](#benchmarks)).
3131
* **Type-safe API** — TypeScript type definitions are available for each feed format, making it easy to work with the data.
3232
* **Tree-shakable** — Only include the parts of the library you need, reducing bundle size.
33-
* **Well-tested** — Comprehensive test suite with over 450 tests and 99.9% code coverage.
33+
* **Well-tested** — Comprehensive test suite with over 650 tests and 99% code coverage.
3434

3535
#### Compatibility
3636
* Works in Node.js and all modern browsers.
@@ -91,24 +91,12 @@ import { parseFeed } from 'feedsmith'
9191

9292
const { type, feed } = parseFeed('feedContent')
9393

94-
console.log('Feed type:', type)
94+
console.log('Feed type:', type) // → rss, atom, json, rdf
9595
console.log('Feed title:', feed.title)
9696

97-
if (type === 'atom') {
98-
console.log('Atom feed ID:', feed.id)
99-
}
100-
10197
if (type === 'rss') {
10298
console.log('RSS feed link:', feed.link)
10399
}
104-
105-
if (type === 'json') {
106-
console.log('JSON feed version:', feed.version)
107-
}
108-
109-
if (type === 'rdf') {
110-
console.log('RDF feed link:', feed.link)
111-
}
112100
```
113101

114102
### Dedicated
@@ -390,7 +378,7 @@ A comprehensive set of benchmarks, categorized by various file sizes, is availab
390378
For a quick overview, here are the results of parsing RSS, Atom, and RDF feeds using various JS packages with Tinybench. Feedsmith's results are marked with an asterisk (`*`).
391379

392380
```
393-
📊 RSS feed parsing (50 files × 100KB5MB)
381+
📊 RSS feed parsing (50 files × 100KB5MB)
394382
┌───┬───────────────────────────────┬─────────┬──────────────┬──────────┬──────────┬──────┐
395383
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │
396384
├───┼───────────────────────────────┼─────────┼──────────────┼──────────┼──────────┼──────┤
@@ -404,7 +392,7 @@ For a quick overview, here are the results of parsing RSS, Atom, and RDF feeds u
404392
│ 7 │ @gaphub/feed │ 0.94 │ 1068.621 │ 995.044 │ 1138.913 │ 15 │
405393
└───┴───────────────────────────────┴─────────┴──────────────┴──────────┴──────────┴──────┘
406394
407-
📊 Atom feed parsing (50 files × 100KB5MB)
395+
📊 Atom feed parsing (50 files × 100KB5MB)
408396
┌───┬───────────────────────────┬─────────┬──────────────┬──────────┬──────────┬──────┐
409397
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │
410398
├───┼───────────────────────────┼─────────┼──────────────┼──────────┼──────────┼──────┤
@@ -417,7 +405,7 @@ For a quick overview, here are the results of parsing RSS, Atom, and RDF feeds u
417405
│ 6 │ rss-parser │ 0.18 │ 5539.014 │ 5479.560 │ 5609.397 │ 3 │
418406
└───┴───────────────────────────┴─────────┴──────────────┴──────────┴──────────┴──────┘
419407
420-
📊 RDF feed parsing (50 files × 100KB5MB)
408+
📊 RDF feed parsing (50 files × 100KB5MB)
421409
┌───┬───────────────────────────┬─────────┬──────────────┬──────────┬──────────┬──────┐
422410
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │
423411
├───┼───────────────────────────┼─────────┼──────────────┼──────────┼──────────┼──────┤

benchmarks/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Tests performed in both [Tinybench](https://github.com/tinylibs/tinybench) and [
1414
```
1515
$ bun parsing.ts
1616
17-
⏳ Running: RSS feed parsing (10 files × 5MB50MB)
17+
⏳ Running: RSS feed parsing (10 files × 5MB50MB)
1818
📊 Tinybench results:
1919
┌───┬───────────────────────────────┬─────────┬──────────────┬──────────┬──────────┬──────┐
2020
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │
@@ -42,7 +42,7 @@ $ bun parsing.ts
4242
│ 7 │ rss-parser │ 0.47 │ 2124.764 │ 1973.848 │ 2880.404 │ 7 │
4343
└───┴───────────────────────────────┴─────────┴──────────────┴──────────┴──────────┴──────┘
4444
45-
⏳ Running: RSS feed parsing (50 files × 100KB5MB)
45+
⏳ Running: RSS feed parsing (50 files × 100KB5MB)
4646
📊 Tinybench results:
4747
┌───┬───────────────────────────────┬─────────┬──────────────┬──────────┬──────────┬──────┐
4848
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │
@@ -70,7 +70,7 @@ $ bun parsing.ts
7070
│ 7 │ @gaphub/feed │ 0.97 │ 1028.629 │ 995.308 │ 1064.605 │ 9 │
7171
└───┴───────────────────────────────┴─────────┴──────────────┴──────────┴──────────┴──────┘
7272
73-
⏳ Running: Atom feed parsing (10 files × 5MB50MB)
73+
⏳ Running: Atom feed parsing (10 files × 5MB50MB)
7474
📊 Tinybench results:
7575
┌───┬───────────────────────────┬─────────┬──────────────┬──────────┬──────────┬──────┐
7676
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │
@@ -96,7 +96,7 @@ $ bun parsing.ts
9696
│ 6 │ rss-parser │ 0.43 │ 2307.729 │ 2261.539 │ 2349.484 │ 7 │
9797
└───┴───────────────────────────┴─────────┴──────────────┴──────────┴──────────┴──────┘
9898
99-
⏳ Running: Atom feed parsing (50 files × 100KB5MB)
99+
⏳ Running: Atom feed parsing (50 files × 100KB5MB)
100100
📊 Tinybench results:
101101
┌───┬───────────────────────────┬─────────┬──────────────┬──────────┬──────────┬──────┐
102102
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │
@@ -122,7 +122,7 @@ $ bun parsing.ts
122122
│ 6 │ rss-parser │ 0.18 │ 5555.357 │ 5511.098 │ 5617.978 │ 5 │
123123
└───┴───────────────────────────┴─────────┴──────────────┴──────────┴──────────┴──────┘
124124
125-
⏳ Running: RDF feed parsing (50 files × 100KB5MB)
125+
⏳ Running: RDF feed parsing (50 files × 100KB5MB)
126126
📊 Tinybench results:
127127
┌───┬───────────────────────────┬─────────┬──────────────┬──────────┬──────────┬──────┐
128128
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │
@@ -148,7 +148,7 @@ $ bun parsing.ts
148148
│ 6 │ @gaphub/feed │ 0.97 │ 1027.363 │ 1001.367 │ 1051.169 │ 9 │
149149
└───┴───────────────────────────┴─────────┴──────────────┴──────────┴──────────┴──────┘
150150
151-
⏳ Running: JSON feed parsing (50 files × 100KB5MB)
151+
⏳ Running: JSON feed parsing (50 files × 100KB5MB)
152152
📊 Tinybench results:
153153
┌───┬──────────────┬─────────┬──────────────┬──────────┬──────────┬──────┐
154154
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │

0 commit comments

Comments
 (0)