Skip to content

Commit 075c3d0

Browse files
committed
Minor documentation updates.
1 parent 74b6fc2 commit 075c3d0

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

guides/design-overview/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Design Overview
22

3-
The interfaces provided by {ruby Protocol::HTTP} underpin all downstream implementations. Therefore, we provide some justification for the design choices.
3+
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.
44

55
## Request/Response Model
66

readme.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
Provides abstractions for working with the HTTP protocol.
44

5-
[![Development Status](https://github.com/socketry/protocol-http/workflows/Test/badge.svg)](https://github.com/socketry/protocol-http/actions?workflow=Test)
5+
[![Development
6+
Status](https://github.com/socketry/protocol-http/workflows/Test/badge.svg)](https://github.com/socketry/protocol-http/actions?workflow=Test)
67

78
## Features
89

@@ -12,7 +13,14 @@ Provides abstractions for working with the HTTP protocol.
1213

1314
## Usage
1415

15-
Please see the [project documentation](https://socketry.github.io/protocol-http).
16+
Please see the [project documentation](https://github.com/socketry/protocol-http) for more details.
17+
18+
- [Getting Started](https://github.com/socketry/protocol-httpguides/getting-started/index) - This guide explains how
19+
to use `protocol-http` for building abstract HTTP interfaces.
20+
21+
- [Design Overview](https://github.com/socketry/protocol-httpguides/design-overview/index) - The interfaces provided
22+
by <code class="language-ruby">Protocol::HTTP</code> underpin all downstream implementations. Therefore, we provide
23+
some justification for the design choices.
1624

1725
## Contributing
1826

@@ -26,7 +34,10 @@ We welcome contributions to this project.
2634

2735
## See Also
2836

29-
- [protocol-http1](https://github.com/socketry/protocol-http1) — HTTP/1 client/server implementation using this interface.
30-
- [protocol-http2](https://github.com/socketry/protocol-http2) — HTTP/2 client/server implementation using this interface.
31-
- [async-http](https://github.com/socketry/async-http) — Asynchronous HTTP client and server, supporting multiple HTTP protocols & TLS.
37+
- [protocol-http1](https://github.com/socketry/protocol-http1) — HTTP/1 client/server implementation using this
38+
interface.
39+
- [protocol-http2](https://github.com/socketry/protocol-http2) — HTTP/2 client/server implementation using this
40+
interface.
41+
- [async-http](https://github.com/socketry/async-http) — Asynchronous HTTP client and server, supporting multiple HTTP
42+
protocols & TLS.
3243
- [async-websocket](https://github.com/socketry/async-websocket) — Asynchronous client and server WebSockets.

0 commit comments

Comments
 (0)