Create 2.0.0 release

webuni · Feb 2, 2024 · 3e207c9 · 3e207c9
1 parent 8e28c26
commit 3e207c9
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 3 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -11,3 +11,6 @@ max_line_length = 120
 
 [*.php]
 indent_size = 4
+
+[composer.*]
+indent_size = 4
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,7 @@
 CHANGELOG
 =========
 
-2.0.0 (2023-12-22)
+2.0.0 (2024-02-02)
 ------------------
 
 * Enable Symfony 7

diff --git a/README.md b/README.md
@@ -19,6 +19,53 @@ This library can be installed via Composer:
 Usage
 -----
 
+This library can parse all form of front matter:
+
+<table>
+<thead><tr><th>YAML (Neon)</th><th>TOML</th><th>Json</th></tr></thead>
+<tbody><tr>
+<td>
+
+```markdown
+---
+foo: bar
+---
+
+# h1
+
+paragraph
+```
+
+</td>
+<td>
+
+```markdown
++++
+foo = bar
++++
+
+# h1
+
+paragraph
+```
+
+</td>
+<td>
+
+```markdown
+{
+  "foo": "bar"
+}
+
+# h1
+
+paragraph
+```
+
+</td>
+</tr></tbody>
+</table>
+
 ### Parse an arbitrary string
 
 ```php
@@ -95,8 +142,8 @@ Hello world!
 Available converters:
 
 | Converter                                 | Twig                                                       |
-| ----------------------------------------- | ---------------------------------------------------------- |
-| `DataToTwigConvertor::nothing()`          | ``                                                         |
+| ----------------------------------------- |------------------------------------------------------------|
+| `DataToTwigConvertor::nothing()`          |                                                            |
 | `DataToTwigConvertor::vars()`             | `{% set key1 = value1 %}`                                  |
 | `DataToTwigConvertor::vars(false)`        | `{% set key1 = key1 is defined ? key1 : value1 %}`         |
 | `DataToTwigConvertor::var('name')`        | `{% set name = {key1: value1, key2: value2} %}`            |
@@ -133,5 +180,6 @@ Alternatives
 ------------
 
 - https://github.com/spatie/yaml-front-matter
+- https://github.com/ergebnis/front-matter
 - https://github.com/mnapoli/FrontYAML
 - https://github.com/Modularr/YAML-FrontMatter