add overview of the jemalloc cartes to the main README
This commit is contained in:
parent
996e5b3926
commit
192af49771
10
README.md
10
README.md
|
@ -5,6 +5,16 @@
|
|||
> Links against `jemalloc` and provides a `Jemalloc` unit type that implements
|
||||
> the allocator APIs and can be set as the `#[global_allocator]`
|
||||
|
||||
## Overview
|
||||
|
||||
The `jemalloc` support ecosystem consists of the following crates:
|
||||
|
||||
* `jemalloc-sys`: builds and links against `jemalloc` exposing raw C bindings to it.
|
||||
* `jemallocator`: provides the `Jemalloc` type which implements the
|
||||
`GlobalAlloc` and `Alloc` traits.
|
||||
* `jemalloc-ctl`: high-level wrapper over `jemalloc`'s control and introspection
|
||||
APIs (the `mallctl*()` family of functions and the _MALLCTL NAMESPACE_)'
|
||||
|
||||
## Documentation
|
||||
|
||||
* [Latest release (docs.rs)][docs.rs]
|
||||
|
|
Loading…
Reference in New Issue