Skip to content

Commit 4de8deb

Browse files
committed
docs(README): gif in the readme
1 parent 69c5ba9 commit 4de8deb

File tree

5 files changed

+31
-10
lines changed

5 files changed

+31
-10
lines changed

Cargo.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,6 @@ step-on-lego = ["oorandom"]
2929
[[bench]]
3030
name = "transmute"
3131
harness = false
32+
33+
[[example]]
34+
name = "segfault"

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,7 @@
2424
- **🦀 Built in 100% memory-safe Rust**
2525

2626
## Example
27-
```rs
28-
// With cve-rs, you can crash prod in a 🔥 blazingly fast manner!
29-
pub fn segfault() {
30-
let null: &mut u8 = cve_rs::null_mut::<u8>();
31-
*null = 42;
32-
}
33-
```
34-
35-
![Segfault demo](/assets/segfault-demo.png)
27+
![Segfault demo](/vhs/cassete.gif)
3628

3729
Rust is an amazing language. You can program a lot of useful things while ensuring that your program will stay safe. Unfortunately, safe Rust is quite limiting. For example, you cannot introduce code that could corrupt the program's memory. Now, with **cve-rs**, you can corrupt your program's memory without corrupting your program's memory.
3830

@@ -97,4 +89,4 @@ This project is licensed under the [GLWTSPL](/LICENSE).
9789

9890
![Good Luck](https://github.com/me-shaon/GLWTPL/raw/master/good-luck.gif)
9991

100-
...and godspeed.
92+
...and godspeed.

examples/segfault.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
// With cve-rs, you can crash prod in a 🔥 blazingly fast manner!
2+
fn main() {
3+
let null: &mut u8 = cve_rs::null_mut::<u8>();
4+
*null = 42;
5+
}

vhs/cassete.gif

325 KB
Loading

vhs/cassete.tape

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Set Theme "Catppuccin Mocha"
2+
Set FontFamily "JetBrainsMono Nerd Font"
3+
Set Margin 20
4+
Set MarginFill "#B4BEFE"
5+
Set TypingSpeed 0.1
6+
Set Shell fish
7+
Type "Blazingly 🔥 fast 🚀 memory vulnerabilities, written in 100% safe Rust. 🦀 "
8+
Ctrl+C
9+
Sleep 1.5s
10+
Type "bat exa"
11+
Tab
12+
Type "seg"
13+
Tab
14+
Enter
15+
Sleep 5s
16+
Type "car"
17+
Tab
18+
Type " run --example segfault"
19+
Sleep 5s
20+
Enter
21+
Sleep 3s

0 commit comments

Comments
 (0)