Skip to content

Commit b4cab24

Browse files
committed
Boof up the README.
1 parent d3c2c0b commit b4cab24

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,23 @@
22

33
[![Tests](https://github.com/bgr360/bevy_datasize/actions/workflows/tests.yml/badge.svg)](https://github.com/bgr360/bevy_datasize/actions/workflows/tests.yml)
44

5-
This is a library for tracking memory usage in [Bevy](https://lib.rs/bevy) apps.
5+
`bevy_datasize` is a library for tracking memory usage in
6+
[Bevy](https://lib.rs/bevy) apps.
67

7-
It is based on the [`datasize`](https://lib.rs/datasize) crate.
8+
`bevy_datasize` uses the `DataSize` trait from the [`datasize`] crate to
9+
estimate the runtime memory usage of any components, resources, or assets that
10+
are registered with the `MemoryUsagePlugin`.
11+
12+
The `DataSize` trait can be derived for your own custom types, and you can
13+
inject custom estimators for third party types that do not implement `DataSize`.
14+
See the [`datasize`] docs for more info on that.
15+
16+
[`datasize`]: https://docs.rs/datasize
17+
18+
## Docs
19+
20+
Rustdocs for the main branch can be found
21+
[here](https://bgr360.github.io/bevy_datasize/bevy_datasize/)
822

923
## Example
1024

@@ -39,11 +53,6 @@ fn print_datasize(memory_usage: Res<MemoryUsage>) {
3953
}
4054
```
4155

42-
## Docs
43-
44-
Rustdocs for the main branch can be found
45-
[here](https://bgr360.github.io/bevy_datasize/bevy_datasize/)
46-
4756
## License
4857

4958
Licensed under either of

0 commit comments

Comments
 (0)