Add README

slub · Mar 28, 2024 · f77bf86 · f77bf86
1 parent 23ea68f
commit f77bf86
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# MODS Metadata Reader for PHP
+
+Read [MODS](https://www.loc.gov/standards/mods/) XML into PHP objects that offer some convenient data extraction methods.
+
+Requires at least PHP 7.4.
+
+## Usage
+
+* Create new instance of reader and pass the MODS XML as SimpleXMLElement.
+
+## TODOs:
+
+* Add missing reading for metadata (currently only the reading of top-level elements is implemented)
+* Add test coverage