diff --git a/README.md b/README.md index 3fe55e2..15ae80e 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ ![Docs](https://github.com/snormore/owned-ref-cell/actions/workflows/docs.yml/badge.svg) [![codecov](https://codecov.io/gh/snormore/owned-ref-cell/graph/badge.svg?token=TGH857JV5B)](https://codecov.io/gh/snormore/owned-ref-cell) -The main class in this library, `OwnedRefCell`, provides an interface similar to `RefCell`, allowing both mutable and immutable borrows, tracked at runtime to ensure that there are no value races. `OwnedRefCell` should be used when you need temporary mutable access to value inside a value structure that does not itself provide intrinsic mutable access. Similar to `RefCell`, this implementation is not thread-safe; it does not implement `Sync`. If you need thread-safe interior mutability, consider using `Mutex`, `RwLock`, or `Atomic` types. +The main class in this library, [`OwnedRefCell`](https://github.com/snormore/owned-ref-cell/blob/main/src/lib.rs), provides an interface similar to [`RefCell`](https://github.com/rust-lang/rust/blob/master/library/core/src/cell.rs), allowing both mutable and immutable borrows, tracked at runtime to ensure that there are no value races. `OwnedRefCell` should be used when you need temporary mutable access to value inside a value structure that does not itself provide intrinsic mutable access. Similar to `RefCell`, this implementation is not thread-safe; it does not implement `Sync`. If you need thread-safe interior mutability, consider using `Mutex`, `RwLock`, or `Atomic` types. ## Features