updated README, description, TODOs

aarc-rs · Oct 10, 2024 · 2c6d4e4 · 2c6d4e4
1 parent 4dba987
commit 2c6d4e4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/Cargo.toml b/Cargo.toml
@@ -2,7 +2,7 @@
 name = "fast-smr"
 version = "0.1.0"
 edition = "2021"
-description = "A fast and robust implementation of safe memory reclamation."
+description = "Toward fast, wait-free, portable, and robust memory reclamation."
 homepage = "https://github.com/aarc-rs/"
 repository = "https://github.com/aarc-rs/fast-smr"
 license = "MIT"

diff --git a/README.md b/README.md
@@ -1 +1,9 @@
 # fast-smr
+
+Toward fast, wait-free, portable, and robust memory reclamation.
+
+### TODOs:
+- [ ] relax atomic orderings from SeqCst to Acq/Rel
+- [ ] bring back an unsafe variant of wait-free `protect`
+- [ ] add docs and update this README
+- [ ] add an era counter for platforms without `AtomicU64`