kotovalexarian/digest-keccak
1
0
Fork 0
Code Releases Activity

Improve README.md

Browse source
This commit is contained in:
Alex Kotov 2019-10-04 05:56:57 +05:00
parent 87e53d598a
commit 263b0d8045
Signed by: kotovalexarian
GPG key ID: 553C0EBBEB5D5F08
1 changed files with 27 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -8,6 +8,14 @@ is almost identical to that of the `digest` standard library.
Table of contents
-----------------
* [Usage](#usage)
* [Development](#development)
Usage
-----
@ -19,29 +27,29 @@ Unless the user specifies otherwise, this Ruby extension assumes 512-bit.
require 'digest/keccak'
# Generate 512-bit digest.
Digest::Keccak.digest("foo") # => "\025\227\204*..."
Digest::Keccak.hexdigest("foo") # => "1597842a..."
Digest::Keccak.digest 'foo' #=> "\x15\x97\x84*\xACR\xBC\x9D..."
Digest::Keccak.hexdigest 'foo' #=> "1597842aac52bc9d..."
# Generate 224-bit digest.
Digest::Keccak.digest("foo", 224) # => "\332\251M\247..."
Digest::Keccak.hexdigest("foo", 224) # => "daa94da7..."
Digest::Keccak.digest 'foo', 224 #=> "\xDA\xA9M\xA7\xF6\x80k\xF5..."
Digest::Keccak.hexdigest 'foo', 224 #=> "daa94da7f6806bf5..."
# Use this interface to feed data in chunks. 512-bit by default.
digest = Digest::Keccak.new
digest.update("f")
digest.update("o")
digest.update("o")
digest.digest # => "\025\227\204*..."
digest.hexdigest # => "1597842a..."
digest.update 'f'
digest.update 'o'
digest.update 'o'
digest.digest #=> "\x15\x97\x84*\xACR\xBC\x9D..."
digest.hexdigest #=> "1597842aac52bc9d..."
# You can pass a hash length to the constructor.
digest = Digest::Keccak.new(224)
digest = Digest::Keccak.new 224
```
Running the test suite
----------------------
Development
-----------
Run the test suite as follows: