Release v1.0.3, deprecate crate.

CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 No unreleased changes yet
 
+## 1.0.3 - 2023-07-11
+
+- Crate is deprecated, use `portable-atomic` instead.
+
 ## 1.0.2 - 2023-03-12
 
 - Add MSP430 support.

Cargo.toml

@@ -6,7 +6,7 @@ license = "MIT OR Apache-2.0"
 name = "atomic-polyfill"
 readme = "README.md"
 repository = "https://github.com/embassy-rs/atomic-polyfill"
-version = "1.0.2"
+version = "1.0.3"
 
 categories = [
   "embedded",

README.md

@@ -1,3 +1,17 @@
+# ⚠️ THIS CRATE IS DEPRECATED ⚠️
+
+**Use [`portable-atomic`](https://crates.io/crates/portable-atomic) instead.** It supports many more architectures and more efficient ways of emulating atomics.
+
+`portable-atomic` with the `critical-section` feature is a drop-in replacement. It uses the `critical-section` crate to ensure locking, just like `atomic-polyfill`.
+
+However, if your chip is single-core, you might want to enable the `unsafe-assume-single-core` feature instead. It makes `portable-atomic` emulate atomics by disabling interrupts.
+It is faster than using a `critical-section` implementation that disables interrupts, because it allows disabling them only on CAS operations, not in load/store operations.
+
+**If you're writing a library**, add a dependency on `portable-atomic` but do NOT enable any feature on it. Let the end user of your library enable the right features for their target.
+If you enable features, you're taking their choice away.
+
+-----
+
 # atomic-polyfill
 
 [![Documentation](https://docs.rs/atomic-polyfill/badge.svg)](https://docs.rs/atomic-polyfill)

src/lib.rs

@@ -1,5 +1,6 @@
 #![no_std]
 #![cfg_attr(reexport_core, forbid(unsafe_code))]
+#![doc = include_str!("../README.md")]
 
 #[cfg(reexport_core)]
 pub use core::sync::atomic::*;