initial release

[squeep-web-linking] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..b332bc4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# An RFC8288 Parsing Library
+
+## What
+
+This is a minimal parser for HTTP Link Headers, basically just a wrapper around a PEG grammar.
+
+## Notes
+
+After updating the grammar, `npm run generate` will compile the parser.