Merge branch 'master' into dev/contributing

.markdownlint.jsonc

@@ -0,0 +1,10 @@
+{
+  "default": true,
+  "MD010": {
+    "code_blocks": false
+  },
+  "MD013": {
+    "code_blocks": false,
+    "tables": false
+  }
+}

.pre-commit-config.yaml

@@ -21,3 +21,15 @@ repos:
     additional_dependencies:
     - flake8-bugbear==23.9.16
     - flake8-comprehensions==3.14.0
+- repo: https://github.com/igorshubovych/markdownlint-cli
+  rev: v0.37.0
+  hooks:
+  - id: markdownlint
+- repo: https://github.com/thlorenz/doctoc
+  rev: v2.2.0
+  hooks:
+  - id: doctoc
+    files: |
+      (?x)^(
+        CONTRIBUTING\.md
+      )

CONTRIBUTING.md

@@ -15,4 +15,4 @@ below.
 
 To provide feedback on the design and the API of metsrw, please refer yourself to the [metsrw wiki].
 
-[metsrw wiki]: https://github.com/artefactual-labs/mets-reader-writer/wiki
+[metsrw wiki]: https://github.com/artefactual-labs/mets-reader-writer/wiki

README.md

@@ -1,16 +1,18 @@
-[![PyPI version](https://badge.fury.io/py/metsrw.svg)](https://badge.fury.io/py/metsrw) [![codecov](https://codecov.io/gh/artefactual-labs/mets-reader-writer/branch/master/graph/badge.svg?token=1cXYbNlgJr)](https://codecov.io/gh/artefactual-labs/mets-reader-writer)
-
 # METS Reader & Writer
 
 By [Artefactual](https://www.artefactual.com/)
 
+[![PyPI version](https://badge.fury.io/py/metsrw.svg)](https://badge.fury.io/py/metsrw)
+[![GitHub CI](https://github.com/artefactual-labs/mets-reader-writer/actions/workflows/test.yml/badge.svg)](https://github.com/artefactual-labs/mets-reader-writer/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/artefactual-labs/mets-reader-writer/branch/master/graph/badge.svg?token=1cXYbNlgJr)](https://codecov.io/gh/artefactual-labs/mets-reader-writer)
+
 METSRW is a library to help with parsing and creating METS files.
 It provides an API, and abstracts away the actual creation of the XML.
-METSRW was initially created for use in [Archivematica](https://github.com/artefactual/archivematica/) and is managed as part of that project.
-
-You are free to copy, modify, and distribute metsrw with attribution under the terms of the AGPL license.
-See the [LICENSE](LICENSE) file for details.
+METSRW was initially created for use in [Archivematica](https://github.com/artefactual/archivematica/)
+and is managed as part of that project.
 
+You are free to copy, modify, and distribute metsrw with attribution under the
+terms of the AGPL license. See the [LICENSE](LICENSE) file for details.
 
 ## Installation & Dependencies
 
@@ -37,7 +39,6 @@ Create a new METS file
 
     mets = metsrw.METSDocument()
 
-
 ## Contributing
 
 METSRW is in early development and welcomes feedback on the API and overall design!