update readme

.changeset/mighty-falcons-design.md

@@ -0,0 +1,5 @@
+---
+"ultramatter": patch
+---
+
+Update readme

.github/workflows/ci.yml

@@ -11,6 +11,11 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.event_name == 'pull_request_target' && github.head_ref || github.ref }}
   cancel-in-progress: true
 
+permissions:
+  contents: write
+  pull-requests: write
+  packages: write
+
 jobs:
   build:
     name: Build Packages

LICENSE

@@ -19,17 +19,3 @@ EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
-
----
-
-Portions of this code were borrowed from https://github.com/developit/htmlParser
-
-The MIT License (MIT)
-
-Copyright (c) 2013 Jason Miller
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,9 +1,17 @@
 # `ultramatter`
 
-A 700B library for parsing frontmatter. `ultramatter` has zero dependencies and is compatible with any JavaScript runtime.
+A <1kB library for parsing frontmatter. `ultramatter` has zero dependencies and is compatible with any JavaScript runtime.
 
 ### Features
 
 - It's very small.
 - It's very fast.
-- It supports a small, friendly subset of YAML (basically just what you need for writing frontmatter)
+- It supports a small, relaxed subset of YAML
+  - Maps (`key: value`)
+  - Sequences (`- list`)
+  - Inline Arrays (`[0, 1, 2]`)
+  - Literal Blocks (`|`)
+  - Comments (`# comment`)
+  - Quoted values (`'single'`, `"double"`)
+  - Boolean values (`true` and `false` ONLY)
+  - Tabs are valid