diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 4963fb3..2cde6a8 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,4 +1,4 @@ -name: Ruby +name: CI Build on: push: diff --git a/.yardopts b/.yardopts index 8ec3e55..5c2737f 100644 --- a/.yardopts +++ b/.yardopts @@ -2,4 +2,5 @@ --hide-void-return --markup-provider=redcarpet --markup markdown +- CHANGELOG.md - LICENSE.md diff --git a/README.md b/README.md index 0e7cf1d..994879f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ # The ProcessExecuter Gem [![Gem Version](https://badge.fury.io/rb/process_executer.svg)](https://badge.fury.io/rb/process_executer) -[![Build Status](https://github.com/main-branch/process_executer/workflows/Ruby/badge.svg?branch=main)](https://github.com/main-branch/process_executer/actions?query=workflow%3ARuby) +[![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/process_executer/) +[![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/process_executer/file/CHANGELOG.md) +[![Build Status](https://github.com/main-branch/process_executer/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/main-branch/process_executer/actions?query=workflow%3ACI%20Build) [![Maintainability](https://api.codeclimate.com/v1/badges/0b5c67e5c2a773009cd0/maintainability)](https://codeclimate.com/github/main-branch/process_executer/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/0b5c67e5c2a773009cd0/test_coverage)](https://codeclimate.com/github/main-branch/process_executer/test_coverage) ## Features -This gem contains the following features: +[Full YARD documentation](https://rubydoc.info/gems/process_executer/) for this +gem is hosted on RubyGems.org. + +This gem contains the following important classes: ### ProcessExecuter::MonitoredPipe diff --git a/process_executer.gemspec b/process_executer.gemspec index 9c364e2..f624608 100644 --- a/process_executer.gemspec +++ b/process_executer.gemspec @@ -18,7 +18,7 @@ Gem::Specification.new do |spec| spec.metadata['homepage_uri'] = spec.homepage spec.metadata['source_code_uri'] = 'https://github.com/main-branch/process_executer' - spec.metadata['changelog_uri'] = 'https://github.com/main-branch/process_executer' + spec.metadata['changelog_uri'] = 'https://rubydoc.info/gems/process_executer/file/CHANGELOG.md' # Specify which files should be added to the gem when it is released. # The `git ls-files -z` loads the files in the RubyGem that have been added into git.