Skip to content

Commit 8b86a87

Browse files
committed
update name to bc-mimalloc
1 parent 87cc20c commit 8b86a87

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,16 @@
55
A drop-in global allocator wrapper around the [mimalloc](https://github.com/microsoft/mimalloc) allocator.
66
Mimalloc is a general purpose, performance oriented allocator built by Microsoft.
77

8+
> **Note:** This is a fork of [`mimalloc`](https://crates.io/crates/mimalloc) /
9+
> [`libmimalloc-sys`](https://crates.io/crates/libmimalloc-sys) published under
10+
> the names **`bc-mimalloc`** and **`bc-libmimalloc-sys`**. It updates the
11+
> bundled mimalloc C library to **v2.2.7** (default) and **v3.2.8** (opt-in via
12+
> the `v3` feature).
13+
814
## Usage
915

1016
```rust
11-
use mimalloc::MiMalloc;
17+
use bc_mimalloc::MiMalloc;
1218

1319
#[global_allocator]
1420
static GLOBAL: MiMalloc = MiMalloc;
@@ -29,20 +35,20 @@ To enable secure mode, put in `Cargo.toml`:
2935

3036
```ini
3137
[dependencies]
32-
mimalloc = { version = "*", features = ["secure"] }
38+
bc-mimalloc = { version = "*", features = ["secure"] }
3339
```
3440

3541
## Usage with v3
3642

37-
By default this library uses mimalloc `v2`.
38-
To enable `v3`, put in `Cargo.toml`:
43+
By default this library uses mimalloc `v2` (currently **v2.2.7**).
44+
To enable `v3` (**v3.2.8**), put in `Cargo.toml`:
3945

4046
```ini
4147
[dependencies]
42-
mimalloc = { version = "*", features = ["v3"] }
48+
bc-mimalloc = { version = "*", features = ["v3"] }
4349
```
4450

45-
[crates.io]: https://crates.io/crates/mimalloc
46-
[Latest Version]: https://img.shields.io/crates/v/mimalloc.svg
47-
[Documentation]: https://docs.rs/mimalloc/badge.svg
48-
[docs.rs]: https://docs.rs/mimalloc
51+
[crates.io]: https://crates.io/crates/bc-mimalloc
52+
[Latest Version]: https://img.shields.io/crates/v/bc-mimalloc.svg
53+
[Documentation]: https://docs.rs/bc-mimalloc/badge.svg
54+
[docs.rs]: https://docs.rs/bc-mimalloc

0 commit comments

Comments
 (0)