Skip to content

Commit 61bde7c

Browse files
committed
Update documentation and links.
1 parent c320706 commit 61bde7c

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

async-websocket.gemspec

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ Gem::Specification.new do |spec|
1515

1616
spec.homepage = "https://github.com/socketry/async-websocket"
1717

18+
spec.metadata = {
19+
"documentation_uri" => "https://socketry.github.io/async-websocket/",
20+
"funding_uri" => "https://github.com/sponsors/ioquatix",
21+
}
22+
1823
spec.files = Dir.glob(['{lib}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__)
1924

2025
spec.required_ruby_version = ">= 3.0"

guides/links.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
getting-started:
22
order: 1
3+
rails-integration:
4+
order: 2

readme.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ An asynchronous websocket client/server implementation for [HTTP/1](https://tool
66

77
## Usage
88

9-
Please see the [project documentation](https://socketry.github.io/async-websocket/) or serve it locally using `bake utopia:project:serve`.
9+
Please see the [project documentation](https://socketry.github.io/async-websocket/) for more details.
10+
11+
- [Getting Started](https://socketry.github.io/async-websocket/guides/getting-started/index) - This guide shows you how to implement a basic client and server.
12+
13+
- [Rails Integration](https://socketry.github.io/async-websocket/guides/rails-integration/index) - This guide explains how to use `async-websocket` with `falcon`.
1014

1115
## Contributing
1216

0 commit comments

Comments
 (0)