Skip to content

Commit de11481

Browse files
committed
docs(readme): add more info
1 parent 32bc01a commit de11481

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
1-
## bitsvec
1+
<div align="center">
2+
<h1><code>bitsvec</code></h1>
23

3-
A bit vector with [the Rust standard library's portable SIMD API](https://github.com/rust-lang/portable-simd).
4+
<p>
5+
<strong>A bit vector with <a href="https://github.com/rust-lang/portable-simd">the Rust standard library's portable SIMD API</a></strong>
6+
</p>
7+
8+
<p>
9+
<a href="https://crates.io/crates/bitsvec"><img src="https://img.shields.io/crates/v/bitsvec.svg" alt="crates.io page" /></a>
10+
<a href="https://docs.rs/bitsvec"><img src="https://docs.rs/bitsvec/badge.svg" alt="docs.rs docs" /></a>
11+
</p>
12+
</div>
413

514
## Usage
615

16+
Add `bitsvec` to `Cargo.toml`:
17+
18+
```toml
19+
bitsvec = "x.y.z"
20+
```
21+
22+
Write some code like this:
23+
724
```rust
825
let mut bitvec = BitVec::ones(1000); // create a bitvec contains 0 ..= 999
926
bitvec.set(900, false); // delete 900 from bitvec
@@ -28,8 +45,6 @@ Compared on AMD Ryzen 9 5900hs, aginst:
2845
* [bitvec_simd 0.15.0](https://docs.rs/bitvec_simd/0.15.0/bitvec_simd/index.html)
2946
* [bitvector_simd 0.2.2](https://docs.rs/bitvector_simd/0.2.2/bitvector_simd/index.html)
3047

31-
<summary><strong>:eyes: See all benchmarks</strong></summary>
32-
3348
<details open>
3449

3550
```
@@ -160,3 +175,12 @@ bitvec 1.0 resize true time: [100.50 us 100.63 us 100.75 us]
160175
## Credits
161176

162177
Most code of this crate is from (https://github.com/GCCFeli/bitvec_simd). On top of that, some changes were made.
178+
179+
## License
180+
181+
This library is licensed under either of:
182+
183+
* MIT license [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
184+
* Apache License 2.0 [LICENSE-APACHE](LICENSE-APACHE) or https://opensource.org/licenses/Apache-2.0
185+
186+
at your option.

0 commit comments

Comments
 (0)