Skip to content

Commit 60ec2ee

Browse files
committed
Add badges
1 parent d6f5cd2 commit 60ec2ee

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# crc32fast-lib
22

3+
[![Tests](https://github.com/awesomized/crc32fast-lib-rust/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/awesomized/crc32fast-lib-rust/actions/workflows/tests.yml)
4+
[![Latest Version](https://img.shields.io/crates/v/crc32fast-lib.svg)](https://crates.io/crates/crc32fast-lib)
5+
[![Documentation](https://img.shields.io/badge/api-rustdoc-blue.svg)](https://docs.rs/crc32fast-lib)
6+
37
Fast, SIMD-accelerated [CRC-32/ISO-HDLC](https://reveng.sourceforge.io/crc-catalogue/all.htm#crc.cat.crc-32-iso-hdlc) (aka `crc32`) checksum computation in Rust exposed as a C-compatible shared library.
48

59
Results in a dramatic performance improvement. For example, when [using it via FFI in PHP](https://github.com/awesomized/crc-fast-php), it's >10X faster than PHP's native [crc32](https://www.php.net/crc32) implementation.
@@ -18,4 +22,4 @@ Use the header file and library as you would normally when using a shared librar
1822

1923
- [crc32fast](https://github.com/srijs/rust-crc32fast) - The underlying Rust library which implemented this SIMD-accelerated approach.
2024
- [crc-fast-php](https://github.com/awesomized/crc-fast-php) - An implementation of this library in PHP using FFI.
21-
- [crc64fast-nvme](https://github.com/awesomized/crc64fast-nvme) - A similar project which computes [CRC-64/NVME](https://reveng.sourceforge.io/crc-catalogue/all.htm#crc.cat.crc-64-nvme) checksums at >20GiB/s.
25+
- [crc64fast-nvme](https://github.com/awesomized/crc64fast-nvme) - A similar project which computes [CRC-64/NVME](https://reveng.sourceforge.io/crc-catalogue/all.htm#crc.cat.crc-64-nvme) checksums at >20GiB/s, also with a C-compatible shared library.

0 commit comments

Comments
 (0)