Merge pull request #183 from q9f/q9f/docs/deprecate

gem: add deprecation notice

README.md

@@ -1,11 +1,21 @@
-# Ethereum Ruby library - Ethereum.rb
+# Ethereum for Ruby
 
-[![Build Status](https://travis-ci.org/EthWorks/ethereum.rb.svg?branch=master)](https://travis-ci.org/EthWorks/ethereum.rb) [![security](https://hakiri.io/github/NullVoxPopuli/MetaHash/master.svg)](https://hakiri.io/github/NullVoxPopuli/MetaHash/master) [![Dependency Status](https://gemnasium.com/marekkirejczyk/ethereum.rb.svg)](https://gemnasium.com/marekkirejczyk/ethereum.rb) [![Code Climate](https://codeclimate.com/github/marekkirejczyk/ethereum.rb/badges/gpa.svg)](https://codeclimate.com/github/marekkirejczyk/ethereum.rb)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/q9f/eth.rb/Spec)](https://github.com/q9f/eth.rb/actions)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/q9f/eth.rb)](https://github.com/q9f/eth.rb/releases)
+[![Gem](https://img.shields.io/gem/v/eth)](https://rubygems.org/gems/eth)
+[![Gem](https://img.shields.io/gem/dt/eth)](https://rubygems.org/gems/eth)
+[![Visitors](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fq9f%2Feth.rb&count_bg=%2379C83D&title_bg=%23555555&icon=rubygems.svg&icon_color=%23FF0000&title=visitors&edge_flat=false)](https://hits.seeyoufarm.com)
+[![codecov](https://codecov.io/gh/q9f/eth.rb/branch/main/graph/badge.svg?token=IK7USBPBZY)](https://codecov.io/gh/q9f/eth.rb)
+[![Maintainability](https://api.codeclimate.com/v1/badges/469e6f66425198ad7614/maintainability)](https://codeclimate.com/github/q9f/eth.rb/maintainability)
+[![Top Language](https://img.shields.io/github/languages/top/q9f/eth.rb?color=red)](https://github.com/q9f/eth.rb/pulse)
+[![Yard Doc API](https://img.shields.io/badge/documentation-API-blue)](https://q9f.github.io/eth.rb)
+[![Usage Wiki](https://img.shields.io/badge/usage-WIKI-blue)](https://github.com/q9f/eth.rb/wiki)
+[![Open-Source License](https://img.shields.io/github/license/q9f/eth.rb)](LICENSE)
+[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/q9f/eth.rb/issues)
 
-The goal of ethereum.rb is to make interacting with the Ethereum blockchain from Ruby as fast and easy as possible (but not easier!).
+A straightforward library to build, sign, and broadcast Ethereum transactions. It allows the separation of key and node management. Sign transactions and handle keys anywhere you can run Ruby and broadcast transactions through any local or remote node. Sign messages and recover signatures for authentication.
 
-## Maintainer
-Project is currently maintained by [@kurotaky](https://github.com/kurotaky).
+**Note,** this repository is just a public archive of the no longer maintained `ethereum` gem. For the partial rewrite and merge with the `eth` gem see [q9f/eth.rb](https://github.com/q9f/eth.rb/).
 
 ## Highlights
 
@@ -122,7 +132,7 @@ Functions defined in a contract are exposed using the following conventions:
 
 ```ruby
 contract.transact.[function_name](params)
-contract.transact_and_wait.[function_name](params)  
+contract.transact_and_wait.[function_name](params)
 contract.call.[function_name](params)
 ```
 

ethereum.gemspec

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ethereum/version'
+
+lib = File.expand_path("lib", __dir__).freeze
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
+
+require "ethereum/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ethereum.rb"
@@ -11,9 +14,17 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Ruby Ethereum client using the JSON-RPC interface}
   spec.description   = %q{Ethereum.rb is Ruby Ethereum client using the JSON-RPC interface. Provides interface for sending transactions, creating and interacting with contracts as well as usefull toolkit to work with Ethereum node.}
-  spec.homepage      = "https://github.com/marekkirejczyk/ethereum.rb"
+  spec.homepage      = "https://github.com/q9f/eth.rb"
   spec.license       = "MIT"
 
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/q9f/eth.rb/issues",
+    "changelog_uri" => "https://github.com/q9f/eth.rb/blob/main/CHANGELOG.md",
+    "documentation_uri" => "https://q9f.github.io/eth.rb/",
+    "github_repo" => "https://github.com/q9f/eth.rb",
+    "source_code_uri" => "https://github.com/q9f/eth.rb",
+  }.freeze
+
   if spec.respond_to?(:metadata)
     spec.metadata['allowed_push_host'] = "https://rubygems.org"
   else
@@ -25,13 +36,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib", "bin"]
 
-  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "bundler", "~> 2.3"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "rspec", "~> 3.11"
   spec.add_development_dependency "pry", "~> 0.14"
-  spec.add_development_dependency "eth", "~> 0.4"
+  spec.add_development_dependency "eth", "~> 0.5"
   spec.add_development_dependency "ffi", "~> 1.15"
 
-  spec.add_dependency "activesupport", ">= 4.2"
+  spec.add_dependency "activesupport", "~> 7.0"
   spec.add_dependency "keccak", "~> 1.3"
 end