Skip to content

Commit

Permalink
chore: Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
Bluefinger committed May 10, 2024
1 parent 4191410 commit fe69231
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ All supported PRNGs and compatible structs are provided by the `bevy_prng` crate
#### `bevy_rand` feature activation
```toml
rand_core = "0.6"
bevy_rand = { version = "0.5", features = ["rand_chacha", "wyrand"] }
bevy_rand = { version = "0.7", features = ["rand_chacha", "wyrand"] }
```

#### `bevy_prng` feature activation
```toml
rand_core = "0.6"
bevy_rand = "0.5"
bevy_prng = { version = "0.5", features = ["rand_chacha", "wyrand"] }
bevy_rand = "0.7"
bevy_prng = { version = "0.7", features = ["rand_chacha", "wyrand"] }
```

The summary of what RNG algorithm to choose is: pick `wyrand` for almost all cases as it is faster and more portable than other algorithms. For cases where you need the extra assurance of entropy quality (for security, etc), then use `rand_chacha`. For more information, [go here](https://docs.rs/bevy_rand/latest/bevy_rand/tutorial/ch01_choosing_prng/index.html).
Expand Down Expand Up @@ -126,18 +126,18 @@ fn setup_npc_from_source(

`bevy_rand` uses the same MSRV as `bevy`.

| `bevy` | `bevy_rand` |
| ------ | ----------- |
| v0.13 | v0.5, v0.6 |
| v0.12 | v0.4 |
| v0.11 | v0.2, v0.3 |
| v0.10 | v0.1 |
| `bevy` | `bevy_rand` |
| ------ | ------------ |
| v0.13 | v0.5 - v0.7 |
| v0.12 | v0.4 |
| v0.11 | v0.2 - v0.3 |
| v0.10 | v0.1 |

The versions of `rand_core`/`rand` that `bevy_rand` is compatible with is as follows:

| `bevy_rand` | `rand_core` | `rand` |
| ------------ | ----------- | ------ |
| v0.1 -> v0.6 | v0.6 | v0.8 |
| v0.1 -> v0.7 | v0.6 | v0.8 |

## Migrations

Expand Down

0 comments on commit fe69231

Please sign in to comment.