Skip to content

Commit

Permalink
improved readme for docs.rs
Browse files Browse the repository at this point in the history
  • Loading branch information
teh-cmc committed Dec 10, 2024
1 parent 9cff3e2 commit bf41875
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,14 @@ Revy works by snapshotting diffs of the Bevy database every frame that are then
This allows you to inspect and visualize the state of the engine at any point in time, either in real-time or after the fact.
These recordings can then be shared to be replayed or e.g. attached to bug reports.

<!-- NOTE: This one is for rendering on Github -->
https://github.com/rerun-io/revy/assets/2910679/cd096cbe-5e68-4acf-8010-e6c32c5568dc

<!-- NOTE: This one is for rendering on docs.rs -->
<video width="100%" autoplay loop muted controls>
<source src="https://github.com/rerun-io/revy/assets/2910679/cd096cbe-5e68-4acf-8010-e6c32c5568dc" type="video/mp4" />
</video>

## Examples

|[Breakout](https://github.com/bevyengine/bevy/blob/v0.15.0/examples/games/breakout.rs)|[3D shapes](https://github.com/bevyengine/bevy/blob/v0.15.0/examples/3d/3d_shapes.rs)|[Alien Cake Addict](https://github.com/bevyengine/bevy/blob/v0.15.0/examples/games/alien_cake_addict.rs)|
Expand Down
2 changes: 2 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#![doc = include_str!("../README.md")]

use bevy::prelude::*;

// ---
Expand Down

0 comments on commit bf41875

Please sign in to comment.