diff --git a/protocol-http.gemspec b/protocol-http.gemspec index d1118dd..6e283aa 100644 --- a/protocol-http.gemspec +++ b/protocol-http.gemspec @@ -15,6 +15,10 @@ Gem::Specification.new do |spec| spec.homepage = "https://github.com/socketry/protocol-http" + spec.metadata = { + "documentation_uri" => "https://socketry.github.io/protocol-http/", + } + spec.files = Dir.glob(['{lib}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__) spec.required_ruby_version = ">= 2.7.6" diff --git a/readme.md b/readme.md index dd41149..83e692a 100644 --- a/readme.md +++ b/readme.md @@ -12,14 +12,11 @@ Provides abstractions for working with the HTTP protocol. ## Usage -Please see the [project documentation](https://github.com/socketry/protocol-http) for more details. +Please see the [project documentation](https://socketry.github.io/protocol-http/) for more details. - - [Getting Started](https://github.com/socketry/protocol-httpguides/getting-started/index) - This guide explains how - to use `protocol-http` for building abstract HTTP interfaces. + - [Getting Started](https://socketry.github.io/protocol-http/guides/getting-started/index) - This guide explains how to use `protocol-http` for building abstract HTTP interfaces. - - [Design Overview](https://github.com/socketry/protocol-httpguides/design-overview/index) - The interfaces provided - by Protocol::HTTP underpin all downstream implementations. Therefore, we provide - some justification for the design choices. + - [Design Overview](https://socketry.github.io/protocol-http/guides/design-overview/index) - This guide explains the high level design of `protocol-http` in the context of wider design patterns that can be used to implement HTTP clients and servers. ## Contributing