Skip to content
This repository has been archived by the owner on Jun 3, 2024. It is now read-only.

Commit

Permalink
Add basic README document.
Browse files Browse the repository at this point in the history
  • Loading branch information
adamreichold committed May 19, 2024
1 parent a00aa20 commit 39485e4
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# lockfree-collector

[![crates.io](https://img.shields.io/crates/v/lockfree-collector.svg)](https://crates.io/crates/lockfree-collector)
[![docs.rs](https://docs.rs/lockfree-collector/badge.svg)](https://docs.rs/lockfree-collector)
[![github.com](https://github.com/adamreichold/lockfree-collector/actions/workflows/test.yaml/badge.svg)](https://github.com/adamreichold/lockfree-collector/actions/workflows/test.yaml)

A lock-free collector which uses blocking to amortize the cost of heap allocations and stealing to keep the collection phase efficient, especially if there no values need to be collected.

## License

Licensed under

* [Apache License, Version 2.0](LICENSE-APACHE) or
* [MIT license](LICENSE-MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

0 comments on commit 39485e4

Please sign in to comment.