README.md
1mruby-digest
2=========
3
4This library is a fork of [github.com/iij/mruby-digest](https://github.com/iij/mruby-digest).
5Unlike the original, this fork does not have any dependencies; it uses [picohash](https://github.com/kazuho/picohash) - a public domain library for hash calculation.
6
7## Features
8
9Message Digest and HMAC classes are available. They are compatible with CRuby's ones.
10
11- Digest::MD5, Digest::RMD160, Digest::SHA1, Digest::SHA256, Digest::SHA384 and
12 Digest::SHA512
13 - Note: some of them are not available if libcrypto.a does not support them on your system.
14- Digest::HMAC
15
16## Install
17 - add conf.gem line to `build_config.rb`
18
19```ruby
20MRuby::Build.new do |conf|
21
22 # ... (snip) ...
23
24 conf.gem :git => 'https://github.com/iij/mruby-digest.git'
25end
26```
27
28## Usage
29```ruby
30Digest::MD5.digest('ruby')
31Digest::MD5.hexdigest('ruby')
32```
33
34## License
35
36Copyright (c) 2012-2015 Internet Initiative Japan Inc., Kazuho Oku
37
38Permission is hereby granted, free of charge, to any person obtaining a
39copy of this software and associated documentation files (the "Software"),
40to deal in the Software without restriction, including without limitation
41the rights to use, copy, modify, merge, publish, distribute, sublicense,
42and/or sell copies of the Software, and to permit persons to whom the
43Software is furnished to do so, subject to the following conditions:
44
45The above copyright notice and this permission notice shall be included in
46all copies or substantial portions of the Software.
47
48THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
49IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
50FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
51AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
52LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
53FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
54DEALINGS IN THE SOFTWARE.
55
56