Skip to content

Commit b16a6fc

Browse files
committed
chore: update README
1 parent cba24a3 commit b16a6fc

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ YAML is a [complex spec](https://ruudvanasseldonk.com/2023/01/11/the-yaml-docume
66

77
An `npm install yaml` weighs about 100kb of minified JavaScript.
88

9-
This static site generator project tries to be as minimalistic as possible, but depends on YAML for
10-
parsing frontmatter, which is a block of meta data in template files.
9+
SmolYAML is used in a static site generator that tries tries to be as minimalistic as possible.
10+
That static site generator depends on YAML for parsing frontmatter, a block of meta data in template files.
11+
But including the full YAML implementation would quite bloat it.
1112

1213
SmolYAML tries to address that by implementing only a small subset of the specification. To be fair,
13-
an opinionated one that is (opinionatedly) considered good enough to parse frontmatter meta data.
14+
it's an opinionated one that is (opinionatedly) considered good enough to parse frontmatter meta data.
1415

1516
In roughly 2KB of minified JavaScript.
1617

@@ -21,7 +22,7 @@ npm i @sissijs/smolyaml
2122
```
2223

2324
```js
24-
import { smolYAML } from 'smolyaml';
25+
import { smolYAML } from '@sissijs/smolyaml';
2526

2627
const metadata = `
2728
name: Lea

0 commit comments

Comments
 (0)