Skip to content

Commit

Permalink
doc: remove ws-rs.org from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
housleyjk committed Feb 15, 2022
1 parent a2e05e7 commit f6db384
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 14 deletions.
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
authors = ["Jason Housley <HousleyJK@gmail.com>"]
description = "Lightweight, event-driven WebSockets for Rust."
documentation = "https://ws-rs.org/docs"
documentation = "https://docs.rs/ws/latest/ws/index.html"
keywords = [
"websocket",
"mio",
Expand All @@ -13,7 +13,7 @@ license = "MIT"
name = "ws"
readme = "README.md"
repository = "https://github.com/housleyjk/ws-rs"
version = "0.9.1"
version = "0.9.2"

[dependencies]
byteorder = "1.2.1"
Expand Down
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Introduction
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
[![Crate](http://meritbadge.herokuapp.com/ws)](https://crates.io/crates/ws)

**[Homepage](https://ws-rs.org)**
**[Homepage](https://github.com/housleyjk/ws-rs/)**

**[API Documentation](https://ws-rs.org/docs)**
**[API Documentation](https://docs.rs/ws/latest/ws/index.html)**

This library provides an implementation of WebSockets,
[RFC6455](https://tools.ietf.org/html/rfc6455) using [MIO](https://github.com/carllerche/mio). It
Expand All @@ -33,21 +33,15 @@ around the WebSocket protocol.
Getting Started
---------------

For detailed installation and usage instructions, check out the [guide](https://ws-rs.org/guide).
Check out the [examples](https://github.com/housleyjk/ws-rs/blob/master/examples/server.rs).


Features
--------

WS-RS provides a complete implementation of the WebSocket specification. There is also support for
[ssl](https://ws-rs.org/guide/ssl) and
[permessage-deflate](https://ws-rs.org/guide/deflate).

Testing
-------

WS-RS is thoroughly tested and passes the [Autobahn Test Suite](https://crossbar.io/autobahn/) for
WebSockets, including the tests for `permessage-deflate`. Visit
[ws-rs.org](https://ws-rs.org/testing/autobahn/results) to view the results of the latest test run.
[ssl](https://github.com/housleyjk/ws-rs/blob/master/examples/ssl-server.rs) and
[permessage-deflate](https://github.com/housleyjk/ws-rs/blob/master/examples/autobahn-server.rs).

Contributing
------------
Expand Down

0 comments on commit f6db384

Please sign in to comment.