From 1e43066d15d6ea6faa0ace8fa69a583367785ec7 Mon Sep 17 00:00:00 2001
From: David Aguilar <davvid@gmail.com>
Date: Tue, 19 Mar 2024 23:34:17 -0700
Subject: [PATCH] README: add an "Upgrading from yaml-rust" section

---
 saphyr/README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/saphyr/README.md b/saphyr/README.md
index 04afc52..18db862 100644
--- a/saphyr/README.md
+++ b/saphyr/README.md
@@ -87,6 +87,21 @@ This implementation is fully compatible with the YAML 1.2 specification. In
 order to help with compliance, `yaml-rust2` tests against (and passes) the [YAML
 test suite](https://github.com/yaml/yaml-test-suite/).
 
+## Upgrading from yaml-rust
+
+You can use `yaml-rust2` as a drop-in replacement for the original `yaml-rust` crate.
+
+```toml
+[dependencies]
+yaml-rust = { version = "#.#", package = "yaml-rust2" }
+```
+
+This `Cargo.toml` declaration allows you to refer to this crate as `yaml_rust` in your code.
+
+```rust
+use yaml_rust::{YamlLoader, YamlEmitter};
+```
+
 ## License
 
 Licensed under either of