Enforce consistent formatting of Markdown files

.dprintrc.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://dprint.dev/schemas/v0.json",
+  "projectType": "openSource",
+  "incremental": true,
+  "markdown": {
+  },
+  "includes": ["**/*.{md}"],
+  "excludes": [
+
+  ],
+  "plugins": [
+    "https://plugins.dprint.dev/markdown-0.6.1.wasm"
+  ]
+}

.github/workflows/ci.yml

@@ -31,6 +31,9 @@ jobs:
       - name: Check code formatting
         run: cargo fmt --all -- --check
 
+      - name: Check markdown formatting
+        uses: dprint/check@v1
+
       - name: Run clippy with default features
         run: cargo clippy --workspace --all-targets -- -D warnings
 

README.md

@@ -1,5 +1,4 @@
-XMR to BTC Atomic Swap
+# XMR to BTC Atomic Swap
-======================
 
 This repository hosts an MVP for atomically swapping BTC to XMR.
 It implements the protocol described in section 3 of [this](https://arxiv.org/abs/2101.12332) paper.

monero-harness/README.md

@@ -1,12 +1,10 @@
-Monero Harness
+# Monero Harness
-==============
 
 Provides an implementation of `testcontainers::Image` for a monero image to run
 `monerod` and `monero-wallet-rpc` in a docker container.
 
 Also provides two standalone JSON RPC clients, one each for `monerod` and `monero-wallet-rpc`.
 
-Example Usage
+## Example Usage
--------------
 
 Please see `tests/*` for example usage.

monero-rpc/README.md

@@ -1,12 +1,10 @@
-Monero Harness
+# Monero Harness
-==============
 
 Provides an implementation of `testcontainers::Image` for a monero image to run
 `monerod` and `monero-wallet-rpc` in a docker container.
 
 Also provides two standalone JSON RPC clients, one each for `monerod` and `monero-wallet-rpc`.
 
-Example Usage
+## Example Usage
--------------
 
 Please see `tests/*` for example usage.

tokio-tar/README.md

@@ -83,10 +83,10 @@ fn main() {
 
 This project is licensed under either of
 
- * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
-   http://www.apache.org/licenses/LICENSE-2.0)
+  http://www.apache.org/licenses/LICENSE-2.0)
- * MIT license ([LICENSE-MIT](LICENSE-MIT) or
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or
-   http://opensource.org/licenses/MIT)
+  http://opensource.org/licenses/MIT)
 
 at your option.