From 558486a54782180524b0e8204aca6267f426aec6 Mon Sep 17 00:00:00 2001 From: Samuel Williams Date: Thu, 17 Aug 2023 12:19:51 +1200 Subject: [PATCH] Add links to documentation. --- console.gemspec | 2 +- readme.md | 14 ++++++++++---- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/console.gemspec b/console.gemspec index cc417f3..6f98a78 100644 --- a/console.gemspec +++ b/console.gemspec @@ -13,7 +13,7 @@ Gem::Specification.new do |spec| spec.cert_chain = ['release.cert'] spec.signing_key = File.expand_path('~/.gem/release.pem') - spec.homepage = "https://github.com/socketry/console" + spec.homepage = "https://socketry.github.io/console/" spec.files = Dir.glob(['{bake,lib}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__) diff --git a/readme.md b/readme.md index 62abad2..3622431 100644 --- a/readme.md +++ b/readme.md @@ -18,7 +18,13 @@ When Ruby decided to reverse the order of exception backtraces, I finally gave u ## Usage -Please see the [project documentation](https://socketry.github.io/console). +Please see the [project documentation](https://socketry.github.io/console/) for more details. + + - [Getting Started](https://socketry.github.io/console/guides/getting-started/index) - This guide explains how to use `console` for logging. + + - [Command Line](https://socketry.github.io/console/guides/command-line/index) - This guide explains how the `console` gem can be controlled using environment variables. + + - [Integration](https://socketry.github.io/console/guides/integration/index) - This guide explains how to integrate the `console` output into different systems. ## Contributing @@ -40,6 +46,6 @@ This project is governed by [Contributor Covenant](https://www.contributor-coven ## See Also -- [console-adapter-rails](https://github.com/socketry/console-adapter-rails) -- [console-adapter-sidekiq](https://github.com/socketry/console-adapter-sidekiq) -- [console-output-datadog](https://github.com/socketry/console-output-datadog) + - [console-adapter-rails](https://github.com/socketry/console-adapter-rails) + - [console-adapter-sidekiq](https://github.com/socketry/console-adapter-sidekiq) + - [console-output-datadog](https://github.com/socketry/console-output-datadog)