From 090dd361fc530f0a6bfe238773239b78aaed91e1 Mon Sep 17 00:00:00 2001
From: Matthias Beyer <mail@beyermatthias.de>
Date: Tue, 19 Mar 2024 18:32:04 +0100
Subject: [PATCH] Use toml instead of diff for toml code snippets (#743)

Use the toml syntax highlighter and format the code snippets as toml
instead of diff, so users can copy-paste it more easily, without having
to edit out the diff makers (+) by hand when they add the snippets to
their Cargo.toml / etc.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
---
 README.md | 46 +++++++++++++++++++++++-----------------------
 1 file changed, 23 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index 0a1888b..9094e2c 100644
--- a/README.md
+++ b/README.md
@@ -36,42 +36,42 @@ generate_api!("path/to/openapi_document.json");
 
 You'll need to add the following to `Cargo.toml`:
 
-```diff
+```toml
 [dependencies]
-+futures = "0.3"
-+progenitor = { git = "https://github.com/oxidecomputer/progenitor" }
-+reqwest = { version = "0.11", features = ["json", "stream"] }
-+serde = { version = "1.0", features = ["derive"] }
+futures = "0.3"
+progenitor = { git = "https://github.com/oxidecomputer/progenitor" }
+reqwest = { version = "0.11", features = ["json", "stream"] }
+serde = { version = "1.0", features = ["derive"] }
 ```
 
 In addition, if the OpenAPI document contains string types with the `format`
 field set to `date` or `date-time`, include
 
-```diff
+```toml
 [dependencies]
-+chrono = { version = "0.4", features = ["serde"] }
+chrono = { version = "0.4", features = ["serde"] }
 ```
 
 Similarly, if there is a `format` field set to `uuid`:
 
-```diff
+```toml
 [dependencies]
-+uuid = { version = "1.0.0", features = ["serde", "v4"] }
+uuid = { version = "1.0.0", features = ["serde", "v4"] }
 ```
 
 And if there are any websocket channel endpoints:
 
-```diff
+```toml
 [dependencies]
-+base64 = "0.21"
-+rand = "0.8"
+base64 = "0.21"
+rand = "0.8"
 ```
 
 If types include regular expression validation:
 
-```diff
+```toml
 [dependencies]
-+regress = "0.4.1"
+regress = "0.4.1"
 ```
 
 The macro has some additional fancy options to control the generated code:
@@ -129,18 +129,18 @@ include!(concat!(env!("OUT_DIR"), "/codegen.rs"));
 
 You'll need to add the following to `Cargo.toml`:
 
-```diff
+```toml
 [dependencies]
-+futures = "0.3"
-+progenitor-client = { git = "https://github.com/oxidecomputer/progenitor" }
-+reqwest = { version = "0.11", features = ["json", "stream"] }
-+serde = { version = "1.0", features = ["derive"] }
+futures = "0.3"
+progenitor-client = { git = "https://github.com/oxidecomputer/progenitor" }
+reqwest = { version = "0.11", features = ["json", "stream"] }
+serde = { version = "1.0", features = ["derive"] }
 
 [build-dependencies]
-+prettyplease = "0.1.25"
-+progenitor = { git = "https://github.com/oxidecomputer/progenitor" }
-+serde_json = "1.0"
-+syn = "1.0"
+prettyplease = "0.1.25"
+progenitor = { git = "https://github.com/oxidecomputer/progenitor" }
+serde_json = "1.0"
+syn = "1.0"
 ```
 
 (`chrono`, `uuid`, `base64`, and `rand` as above)