Skip to content

Commit

Permalink
Add links to documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ioquatix committed Aug 17, 2023
1 parent f50aaa7 commit 558486a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
2 changes: 1 addition & 1 deletion console.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -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__)

Expand Down
14 changes: 10 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)

0 comments on commit 558486a

Please sign in to comment.