Skip to content

Commit

Permalink
Update documentation and links.
Browse files Browse the repository at this point in the history
  • Loading branch information
ioquatix committed Dec 9, 2023
1 parent c320706 commit 61bde7c
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
5 changes: 5 additions & 0 deletions async-websocket.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ Gem::Specification.new do |spec|

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

spec.metadata = {
"documentation_uri" => "https://socketry.github.io/async-websocket/",
"funding_uri" => "https://github.com/sponsors/ioquatix",
}

spec.files = Dir.glob(['{lib}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__)

spec.required_ruby_version = ">= 3.0"
Expand Down
2 changes: 2 additions & 0 deletions guides/links.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
getting-started:
order: 1
rails-integration:
order: 2
6 changes: 5 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ An asynchronous websocket client/server implementation for [HTTP/1](https://tool

## Usage

Please see the [project documentation](https://socketry.github.io/async-websocket/) or serve it locally using `bake utopia:project:serve`.
Please see the [project documentation](https://socketry.github.io/async-websocket/) for more details.

- [Getting Started](https://socketry.github.io/async-websocket/guides/getting-started/index) - This guide shows you how to implement a basic client and server.

- [Rails Integration](https://socketry.github.io/async-websocket/guides/rails-integration/index) - This guide explains how to use `async-websocket` with `falcon`.

## Contributing

Expand Down

0 comments on commit 61bde7c

Please sign in to comment.