rename project and package

nextgraph
Niko PLP 2 weeks ago
parent 8788a92cec
commit 3e9aa12cf3
  1. 6
      Cargo.toml
  2. 28
      README.md

@ -3,12 +3,12 @@ name = "ng-tungstenite"
description = "fork of tungstenite for Nextgraph.org" description = "fork of tungstenite for Nextgraph.org"
categories = [] categories = []
keywords = ["websocket", "io", "web"] keywords = ["websocket", "io", "web"]
authors = ["Alexey Galakhov", "Daniel Abramov"] authors = ["Alexey Galakhov", "Daniel Abramov", "Niko PLP <niko@nextgraph.org>"]
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
readme = "README.md" readme = "README.md"
homepage = "https://github.com/snapview/tungstenite-rs" homepage = "https://git.nextgraph.org/NextGraph/tungstenite-rs"
documentation = "https://docs.rs/tungstenite/0.19.0" documentation = "https://docs.rs/tungstenite/0.19.0"
repository = "https://github.com/snapview/tungstenite-rs" repository = "https://git.nextgraph.org/NextGraph/tungstenite-rs"
version = "0.19.0" version = "0.19.0"
edition = "2018" edition = "2018"
rust-version = "1.51" rust-version = "1.51"

@ -1,4 +1,6 @@
# Tungstenite # ng-tungstenite
fork of https://github.com/snapview/tungstenite-rs for the needs of NextGraph.org
Lightweight stream-based WebSocket implementation for [Rust](https://www.rust-lang.org/). Lightweight stream-based WebSocket implementation for [Rust](https://www.rust-lang.org/).
@ -40,8 +42,8 @@ take a look at [`tokio-tungstenite`](https://github.com/snapview/tokio-tungsteni
[Documentation](https://docs.rs/tungstenite) [Documentation](https://docs.rs/tungstenite)
Introduction ## Introduction
------------
This library provides an implementation of WebSockets, This library provides an implementation of WebSockets,
[RFC6455](https://tools.ietf.org/html/rfc6455). It allows for both synchronous (like TcpStream) [RFC6455](https://tools.ietf.org/html/rfc6455). It allows for both synchronous (like TcpStream)
and asynchronous usage and is easy to integrate into any third-party event loops including and asynchronous usage and is easy to integrate into any third-party event loops including
@ -49,23 +51,21 @@ and asynchronous usage and is easy to integrate into any third-party event loops
WebSocket protocol but still makes them accessible for those who wants full control over the WebSocket protocol but still makes them accessible for those who wants full control over the
network. network.
Why Tungstenite? ## Why Tungstenite?
----------------
It's formerly WS2, the 2nd implementation of WS. WS2 is the chemical formula of It's formerly WS2, the 2nd implementation of WS. WS2 is the chemical formula of
tungsten disulfide, the tungstenite mineral. tungsten disulfide, the tungstenite mineral.
Features ## Features
--------
Tungstenite provides a complete implementation of the WebSocket specification. Tungstenite provides a complete implementation of the WebSocket specification.
TLS is supported on all platforms using `native-tls` or `rustls`. The following TLS is supported on all platforms using `native-tls` or `rustls`. The following
features are available: features are available:
* `native-tls` - `native-tls`
* `native-tls-vendored` - `native-tls-vendored`
* `rustls-tls-native-roots` - `rustls-tls-native-roots`
* `rustls-tls-webpki-roots` - `rustls-tls-webpki-roots`
Choose the one that is appropriate for your needs. Choose the one that is appropriate for your needs.
@ -74,13 +74,11 @@ otherwise you won't be able to communicate with the TLS endpoints.
There is no support for permessage-deflate at the moment, but the PRs are welcome :wink: There is no support for permessage-deflate at the moment, but the PRs are welcome :wink:
Testing ## Testing
-------
Tungstenite is thoroughly tested and passes the [Autobahn Test Suite](https://crossbar.io/autobahn/) for Tungstenite is thoroughly tested and passes the [Autobahn Test Suite](https://crossbar.io/autobahn/) for
WebSockets. It is also covered by internal unit tests as well as possible. WebSockets. It is also covered by internal unit tests as well as possible.
Contributing ## Contributing
------------
Please report bugs and make feature requests [here](https://github.com/snapview/tungstenite-rs/issues). Please report bugs and make feature requests [here](https://github.com/snapview/tungstenite-rs/issues).

Loading…
Cancel
Save