Skip to content

Commit

Permalink
update README.md (again)
Browse files Browse the repository at this point in the history
  • Loading branch information
Creative0708 committed Feb 23, 2024
1 parent d71b881 commit 63a0aae
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
- 🕹️ Paradigm-changing (no more unsafe code!)
- 🔥 Blazingly fast
- 💡 Easy to use
- Featuring way 👋 too 2️⃣ many 🤯 emojis in the 📖 readme 🔥 🦀 💨
- 🏆 Featuring way 👋 too 2️⃣ many 🤯 emojis in the 📖 readme 🔥 🦀 💨
- **🦀 Built in 100% memory-safe Rust**

## Example
Expand All @@ -36,7 +36,7 @@ pub fn segfault() {

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.

We are very committed to making sure **cve-rs** is memory-safe. We know that unsafe code can have unintended consequences, such as memory unsafety that causes bugs like segmentation faults, use-after-frees, and buffer overflows!
We are very committed to making sure **cve-rs** is memory-safe. We know that unsafe code can have unintended consequences, such as memory unsafety that causes bugs like segmentation faults, use-after-frees, and buffer overflows.

That is why **cve-rs** uses `#![deny(unsafe_code)]` in the entire codebase. There is not a single block of `unsafe` code (except for some [tests](./src/transmute.rs#L56)) in this project.

Expand All @@ -58,14 +58,14 @@ That is why **cve-rs** uses `#![deny(unsafe_code)]` in the entire codebase. Ther
To use it as a library:

```sh
$ cargo add cve-rs
cargo add cve-rs
```

Or to run our example binary:

```sh
$ cargo install cve-rs
$ cve-rs
cargo install cve-rs
cve-rs
```

## WASM support
Expand All @@ -79,10 +79,6 @@ cargo build --target wasm32-wasi
wasmer run target/wasm32-wasi/debug/cve-rs.wasm
```

## Wait, how safe is cve-rs?!?

lmao

## Contributors

Special thanks to [@Bright-Shard](https://github.com/Bright-Shard) and [@Creative0708](https://github.com/Creative0708), and everyone else who contributed to **cve-rs**.
Expand All @@ -91,8 +87,14 @@ Special thanks to [@Bright-Shard](https://github.com/Bright-Shard) and [@Creativ

This project is licensed under the [GLWTSPL](/LICENSE).

## Wait, how safe is cve-rs?!?

This project is licensed under the [GLWTSPL](/LICENSE).

## License

This project is licensed under the [GLWTSPL](/LICENSE).

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

...and godspeed.

0 comments on commit 63a0aae

Please sign in to comment.