Skip to content

Commit

Permalink
docs: fix README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
johanns committed Mar 1, 2025
1 parent e227a01 commit 6a1ca45
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A high-performance native binding to the SHA3 (FIPS 202) cryptographic hashing a
> [!CAUTION]
> **Security Notice**: Do not use SHA-3 for hashing passwords. Instead, use a slow hashing function such as PBKDF2, Argon2, bcrypt, or scrypt.
> [!NOTICE]
> [!IMPORTANT]
> **Breaking Changes**: SHA3 version 2.0 introduces breaking changes to the API. Please review the changelog and ensure compatibility with your application.
> If you need the previous behavior, lock your Gemfile to version '~> 1.0'.
Expand Down Expand Up @@ -114,9 +114,9 @@ result = shake.hex_squeeze(120)
binary_result = shake.squeeze(1024)

# You can call squeeze functions multiple times with arbitrary output lengths
first_part = shake.squeeze(32) # Get first 32 bytes
second_part = shake.squeeze(64) # Get next 64 bytes
third_part = shake.hex_squeeze(128) # Get next 128 bytes as hex
first_part = shake.squeeze(32) # Get 32 bytes
second_part = shake.squeeze(64) # Get 64 bytes
third_part = shake.hex_squeeze(128) # Get 128 bytes as hex
```

### Alternate Class Syntax
Expand Down

0 comments on commit 6a1ca45

Please sign in to comment.