Skip to content

Commit

Permalink
Add examples link in docs.
Browse files Browse the repository at this point in the history
Signed-off-by: Tin Svagelj <[email protected]>
  • Loading branch information
Caellian committed Sep 17, 2023
1 parent ec08513 commit 990c336
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ fn main() {
<cite>Note that reference types returned by store are inferred and only shown
here for demonstration purposes.</cite>

For more usage examples see the
[`examples`](https://github.com/Caellian/contiguous_mem/tree/trunk/examples)
directory.

## Alternatives

- manually managing memory to ensure contiguous placement of data
Expand Down
6 changes: 4 additions & 2 deletions doc/crate.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
contiguous_mem streamlines storage and management of data stored in contiguous
memory block.
blocks of memory.

## Implementations

Expand All @@ -11,7 +11,9 @@ details flag:
- [`SyncContiguousMemory`]
- [`UnsafeContiguousMemory`]

See individual items for usage examples.
See individual items for usage examples, as well as project
[`examples`](https://github.com/Caellian/contiguous_mem/tree/trunk/examples)
directory.

## Features

Expand Down

0 comments on commit 990c336

Please sign in to comment.