Set required ruby version and add links to docs in readme

francisco-rojas · Nov 23, 2019 · 882595b · 882595b
1 parent bbb2eef
commit 882595b
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 3 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,12 +1,13 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.5
 
 Metrics/LineLength:
   Max: 120
 
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+    - 'csv_converter.gemspec'
 
 Metrics/MethodLength:
   Exclude:

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    csv_converter (0.1.0)
+    csv_converter (0.1.1)
       activesupport (~> 6.0)
 
 GEM

diff --git a/README.md b/README.md
@@ -116,6 +116,19 @@ Or install it yourself as:
 
     $ gem install csv_converter
 
+## Documentation
+You can view the csv_converter documentation in RDoc format here:
+
+https://rubydoc.info/github/francisco-rojas/csv_converter/master
+
+You can also view the wiki here:
+
+https://github.com/francisco-rojas/csv_converter/wiki
+
+Finally, you can check the Readme and source code here:
+
+https://github.com/francisco-rojas/csv_converter
+
 ## Development
 
 Currently, the library is stable. I believe it supports the most common use cases so most likely the code won't be updated very frequently. However, if you have any feature requests or find a bug feel free to open a github issue and I will reply as soon as I can.

diff --git a/csv_converter.gemspec b/csv_converter.gemspec
@@ -14,9 +14,11 @@ Gem::Specification.new do |spec|
   spec.description   = 'Groups and converts tabulated data based on the mappings provided'
   spec.homepage      = 'https://github.com/francisco-rojas/csv_converter'
   spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.metadata['homepage_uri']     = spec.homepage
   spec.metadata['wiki_uri']         = 'https://github.com/francisco-rojas/csv_converter/wiki'
+  spec.metadata['docs_uri']         = 'https://github.com/francisco-rojas/csv_converter/wiki'
   spec.metadata['source_code_uri']  = 'https://github.com/francisco-rojas/csv_converter'
   spec.metadata['changelog_uri']    = 'https://github.com/francisco-rojas/csv_converter/CHANGELOG.md'
 

diff --git a/lib/csv_converter/version.rb b/lib/csv_converter/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CSVConverter
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end