feat: add migration tips (#230)

* feat: add migration tips Signed-off-by: andylokandy <andylokandy@hotmail.com> * fix Signed-off-by: andylokandy <andylokandy@hotmail.com> --------- Signed-off-by: andylokandy <andylokandy@hotmail.com>
tikv · Jul 17, 2024 · 8ca22e8 · 8ca22e8
1 parent 5ba5151
commit 8ca22e8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -75,4 +75,4 @@
 ## v0.2.0
 
 - All API get redesigned for better egnormic experience.
-- Attribute macro `#[trace]` automactically detects `async fn` and crate `async-trait`, and since that, `#[trace_async]` is removed.
+- Attribute macro `#[trace]` automatically detects `async fn` and crate `async-trait`, and since that, `#[trace_async]` is removed.
diff --git a/README.md b/README.md
@@ -1,3 +1,18 @@
+> [!WARNING]
+> `minitrace` has been renamed to [`fastrace`](https://github.com/fastracelabs/fastrace). Please follow the migration guide to update your code. **This repository is no longer maintained.**
+
+Edit your `Cargo.toml` and find and replace `minitrace` with `fastrace` in the source code:
+
+```diff
+# Cargo.toml
+
+[dependencies]
+- minitrace = "0.6"
++ fastrace = "0.6"
+```
+
+<hr>
+
 <div align="center">
 
   ![minitrace: Extremely fast tracing library for Rust](https://raw.githubusercontent.com/tikv/minitrace-rust/master/etc/img/head-img-640.svg)