From 944bb60ce9d28058365616525b96b8dc929cee75 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sa=C3=BAl=20Cabrera?= <saulecabrera@gmail.com>
Date: Mon, 6 May 2024 19:23:14 -0400
Subject: [PATCH] Deprecate bindings crates

This commit is a follow-up to https://github.com/bytecodealliance/javy/pull/618, to formally mark `quckjs-wasm-{sys, rs}` crates as deprecated.

The rollout strategy is to:

* Merge this PR
* Publish the a new version of each of the crates, containing the last unreleased change in each and the deprecation notice.
---
 crates/quickjs-wasm-rs/CHANGELOG.md  |  1 +
 crates/quickjs-wasm-rs/Cargo.toml    |  3 +++
 crates/quickjs-wasm-rs/README.md     |  9 +++++++++
 crates/quickjs-wasm-sys/CHANGELOG.md |  1 +
 crates/quickjs-wasm-sys/Cargo.toml   |  3 +++
 crates/quickjs-wasm-sys/README.md    | 11 +++++++++++
 6 files changed, 28 insertions(+)

diff --git a/crates/quickjs-wasm-rs/CHANGELOG.md b/crates/quickjs-wasm-rs/CHANGELOG.md
index 8b0ca88d..6afd8c36 100644
--- a/crates/quickjs-wasm-rs/CHANGELOG.md
+++ b/crates/quickjs-wasm-rs/CHANGELOG.md
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- Mark crate as deprecated
 - Add a new `expose-sys` feature that exposes unstable escape hatch functions to the underlying `quickjs_wasm_sys` crate.
 
 ## [3.0.0] - 2024-01-31
diff --git a/crates/quickjs-wasm-rs/Cargo.toml b/crates/quickjs-wasm-rs/Cargo.toml
index 5bfe3e00..59c56fb5 100644
--- a/crates/quickjs-wasm-rs/Cargo.toml
+++ b/crates/quickjs-wasm-rs/Cargo.toml
@@ -22,3 +22,6 @@ serde_bytes = "0.11.14"
 [features]
 # Re-exports the quickjs-wasm-sys module and exposes additional, unstable APIs.
 export-sys = []
+
+[badges]
+maintenance = { status = "deprecated" }
diff --git a/crates/quickjs-wasm-rs/README.md b/crates/quickjs-wasm-rs/README.md
index e8394cd1..b9b84acc 100644
--- a/crates/quickjs-wasm-rs/README.md
+++ b/crates/quickjs-wasm-rs/README.md
@@ -1,3 +1,12 @@
+# This crate is deprecated.
+[![crates.io](https://img.shields.io/crates/v/quickjs-wasm-rs.svg)](https://crates.io/crates/quickjs-wasm-rs)
+
+The motivation for this change is explained in detail in 
+https://github.com/bytecodealliance/javy/pull/618 
+
+We recommend using [`rquickjs`](https://github.com/DelSkayn/rquickjs) as the
+high-level bindings for QuickJS.
+
 # quickjs-wasm-rs
 
 High-level bindings and serializers for a Wasm build of QuickJS.
diff --git a/crates/quickjs-wasm-sys/CHANGELOG.md b/crates/quickjs-wasm-sys/CHANGELOG.md
index 6839029f..5aab0427 100644
--- a/crates/quickjs-wasm-sys/CHANGELOG.md
+++ b/crates/quickjs-wasm-sys/CHANGELOG.md
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased changes
 
+- Mark crate as deprecated.
 - Expose `JS_DupValue` via `JS_DupValueExt`.
 
 ## [1.2.0] - 2024-01-31
diff --git a/crates/quickjs-wasm-sys/Cargo.toml b/crates/quickjs-wasm-sys/Cargo.toml
index bbbb83b5..daa6f404 100644
--- a/crates/quickjs-wasm-sys/Cargo.toml
+++ b/crates/quickjs-wasm-sys/Cargo.toml
@@ -19,3 +19,6 @@ http-body-util = "0.1.1"
 hyper = "1.3"
 hyper-tls = "0.6.0"
 hyper-util = { version = "0.1.3", features = ["http1"] }
+
+[badges]
+maintenance = { status = "deprecated" }
diff --git a/crates/quickjs-wasm-sys/README.md b/crates/quickjs-wasm-sys/README.md
index 5c17ca47..6947c4bb 100644
--- a/crates/quickjs-wasm-sys/README.md
+++ b/crates/quickjs-wasm-sys/README.md
@@ -1,5 +1,16 @@
+# This crate is deprecated.
+[![crates.io](https://img.shields.io/crates/v/quickjs-wasm-sys.svg)](https://crates.io/crates/quickjs-wasm-sys)
+
+The motivation for this change is explained in detail in 
+https://github.com/bytecodealliance/javy/pull/618 
+
+We recommend using [`rquickjs`](https://github.com/DelSkayn/rquickjs) as the
+high-level bindings for QuickJS.
+
 # quickjs-wasm-sys: Wasm QuickJS bindings for Rust
 
+High-level bindings and serializers for a Wasm build of QuickJS.
+
 FFI bindings for a Wasm build of the QuickJS Javascript engine.
 
 ## Publishing to crates.io