Skip to content

Commit

Permalink
Spruce up README (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
jbangelo authored Sep 5, 2024
1 parent 4111330 commit a5947c7
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,25 @@

A dependency free implementation of the Fletcher's checksum algorithm

[![crates.io](https://img.shields.io/crates/v/fletcher.svg)](https://crates.io/crates/fletcher) ![example workflow](https://github.com/jbangelo/fletcher/actions/workflows/build.yml/badge.svg)
[![crates.io](https://img.shields.io/crates/v/fletcher.svg)](https://crates.io/crates/fletcher)
[![docs.rs](https://img.shields.io/docsrs/fletcher)](https://docs.rs/fletcher/latest/fletcher/)
[![Build Status](https://github.com/jbangelo/fletcher/actions/workflows/build.yml/badge.svg)](https://github.com/jbangelo/fletcher)
[![Crates.io License](https://img.shields.io/crates/l/fletcher)](https://github.com/jbangelo/fletcher/blob/main/LICENSE)



Fletcher's Checksum was developed to provide nearly the same error checking
capability as a CRC but with a faster software implementation. This is not a
cryptographically secure checksum, it's only meant to be used for checking
the integrity of data NOT the authenticity.

## Algorithm Pros
## Algorithm Pros
This algorithm is faster to run in software than most CRCs. This is because the
CRC algorithm was originally designed to be simple to implement in hardware, but
not neccesarily in software. The Fletcher Checksum was designed specifically to
be suited for implementation in software.

## Algorithm Cons
## Algorithm Cons
This checksum algorithm does suffer from not being able to distinguish `0xFF`
from `0x00`. Meaning a block of data with all bits set to 1 will have the exact
same the same checksum as a block of data with all bits set to 0. This comes
Expand Down

0 comments on commit a5947c7

Please sign in to comment.