Skip to content

fix(docs): update README for packages/util #382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2022
Merged

fix(docs): update README for packages/util #382

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions packages/util/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# @aws-crypto/crc32c
# @aws-crypto/util

Pure JS implementation of CRC32-C https://en.wikipedia.org/wiki/Cyclic_redundancy_check
Helper functions

## Usage

```
import { Crc32c } from '@aws-crypto/crc32c';

const crc32Digest = (new Crc32c).update(buffer).digest()
import { convertToBuffer } from '@aws-crypto/util';

const data = "asdf";
const utf8EncodedUint8Array = convertToBuffer(data);
```

## Test
Expand Down