From febc68c7803a89c58ce99e42a6302cd04cb0293a Mon Sep 17 00:00:00 2001
From: Thomas Eizinger <thomas@eizinger.io>
Date: Wed, 24 Mar 2021 10:40:02 +1100
Subject: [PATCH] Enforce consistent formatting of Markdown files

---
 .dprintrc.json           | 14 ++++++++++++++
 .github/workflows/ci.yml |  3 +++
 README.md                |  3 +--
 monero-harness/README.md |  6 ++----
 monero-rpc/README.md     |  6 ++----
 tokio-tar/README.md      |  8 ++++----
 6 files changed, 26 insertions(+), 14 deletions(-)
 create mode 100644 .dprintrc.json

diff --git a/.dprintrc.json b/.dprintrc.json
new file mode 100644
index 00000000..c268f318
--- /dev/null
+++ b/.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"
+  ]
+}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index edbbf5a3..d659ea41 100644
--- a/.github/workflows/ci.yml
+++ b/.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
 
diff --git a/README.md b/README.md
index f9652eab..afd68d5f 100644
--- a/README.md
+++ b/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.
diff --git a/monero-harness/README.md b/monero-harness/README.md
index ee15783a..c8b46c5c 100644
--- a/monero-harness/README.md
+++ b/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.
diff --git a/monero-rpc/README.md b/monero-rpc/README.md
index ee15783a..c8b46c5c 100644
--- a/monero-rpc/README.md
+++ b/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.
diff --git a/tokio-tar/README.md b/tokio-tar/README.md
index dc8c2436..5ddc6db0 100644
--- a/tokio-tar/README.md
+++ b/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
-   http://www.apache.org/licenses/LICENSE-2.0)
- * MIT license ([LICENSE-MIT](LICENSE-MIT) or
-   http://opensource.org/licenses/MIT)
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
+  http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or
+  http://opensource.org/licenses/MIT)
 
 at your option.