From 88524d837b3099cf3ba21b9a6a580249135be340 Mon Sep 17 00:00:00 2001 From: Afr Schoe <58883403+q9f@users.noreply.github.com> Date: Thu, 7 Oct 2021 13:35:07 +0200 Subject: [PATCH] docs: fix typo in gemspec and readme (#12) --- README.md | 4 ++-- keccak.gemspec | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 156cf77..4a48b1c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Gem](https://img.shields.io/gem/v/keccak?color=red)](https://rubygems.org/gems/keccak) [![License](https://img.shields.io/github/license/q9f/keccak.rb.svg?color=black)](LICENSE) -This Ruby extension exposes the [Keccak](http://keccak.noekeon.org/) (SHA-3) digest C bindings in the non-final version used by Ethereum. It is based on the reference `C` implementation, version 3.2. The exposed interface is almost identical to that of the `digest` standard library. +This Ruby extension exposes the [Keccak](http://keccak.noekeon.org/) (SHA-3) digest `C` bindings in the non-final version used by [Ethereum](https://ethereum.org). It is based on the reference `C` implementation, version 3.2. The exposed interface is almost identical to that of the `digest` standard library. ## Installation @@ -21,7 +21,7 @@ gem install keccak gem 'keccak', '~> 1.2' ``` -**Note**: as of version `v1.1.0`, `digest-sha3` (historic name) requires Ruby 2.2. The new `keccak` version `v1.2.0` now also supports Ruby 3.0. The last version that worked on older Ruby (1.x) versions was `v1.0.2`. It can be found at the no longer maintained [`digest-sha3` repository from 2015](https://github.com/phusion/digest-sha3-ruby/releases/tag/release-1.0.2). +**Note**: as of version `v1.1.0`, `digest-sha3` (historic name, see below) requires Ruby 2.2. The new `keccak` version `v1.2.0` now also supports Ruby 3.0. The last version that worked on older Ruby (1.x) versions was `v1.0.2`. It can be found at the no longer maintained `digest-sha3` [repository from 2015](https://github.com/phusion/digest-sha3-ruby/releases/tag/release-1.0.2). ## Usage diff --git a/keccak.gemspec b/keccak.gemspec index edb7c90..99e1a1e 100644 --- a/keccak.gemspec +++ b/keccak.gemspec @@ -9,7 +9,7 @@ Gem::Specification.new do |spec| spec.name = "keccak" spec.version = Digest::SHA3::VERSION spec.summary = "The Keccak (SHA-3) hash used by Ethereum." - spec.description = "The Keccak (SHA-3) hash use by Ethereum. This does not implement the final FIPS202 standard, today known as SHA3 but rather an early version, commonly referred to as Keccak." + spec.description = "The Keccak (SHA-3) hash used by Ethereum. This does not implement the final FIPS202 standard, today known as SHA3 but rather an early version, commonly referred to as Keccak." spec.homepage = "https://github.com/q9f/keccak.rb" spec.authors = ["Afri Schoedon", "Alex Kotov", "Chris Metcalfe", "Hongli Lai (Phusion)", "Keccak authors"] spec.email = "%w[ruby@q9f.cc]"