0.15.0

Cargo.toml

@@ -1,117 +1,17 @@
-[package]
-name          = "twitchchat"
-edition       = "2018"
-version       = "0.14.5"
-authors       = ["museun <[email protected]>"]
-keywords      = ["twitch", "irc", "async", "asynchronous", "tokio"]
-license       = "MIT OR Apache-2.0"
-readme        = "README.md"
-description   = "interface to the irc-side of twitch's chat system"
-documentation = "https://docs.rs/twitchchat/latest/twitchchat/"
-repository    = "https://github.com/museun/twitchchat"
-categories    = ["asynchronous", "network-programming", "parser-implementations"]
-
-[package.metadata.docs.rs]
-rustdoc-args = ["--cfg", "docsrs"]
-all-features = true
-
-[features]
-default = []
-testing = [
-    "async",
-    "async-mutex",    
-]
-
-async = [
-    "async-channel",
-    "async-dup",
-    "fastrand",
-    "futures-lite",
-    "futures-timer",
-    "log",
-    "pin-project-lite",
+[workspace]
+members = [
+    "twitchchat",
+    "twitchchat_async_io",
+    "twitchchat_async_net",
+    "twitchchat_async_std",
+    "twitchchat_smol",
+    "twitchchat_tokio",
+    "twitchchat_tokio02",
+    "twitchchat_tungstenite",
+
+    # internal crates
+    # "examples"
 ]
 
-[dependencies]
-# logging support
-log = { version = "0.4", optional = true, features = ["std"] }
-
-# just the futures traits
-futures-lite = { version = "1.11", optional = true }
-
-# field pin projection
-pin-project-lite = { version = "0.1", optional = true }
-
-# cloneable async writes
-async-dup = { version = "1.2", optional = true }
-
-# message passing
-async-channel = { version = "1.5", optional = true }
-
-# for timing out futures
-futures-timer = { version = "3.0", optional = true }
-
-# for 'fairness' in the main loop
-fastrand = { version = "1.4", optional = true }
-
-# for optional serialization and deserialization
-serde = { version = "1.0", features = ["derive"], optional = true }
-
-# optional runtimes (for TcpStream)
-# these use the futures AsyncWrite+AsyncRead
-async-io  = { version = "1.1", optional = true }
-smol      = { version = "1.2", optional = true }
-async-tls = { version = "0.10", default-features = false, features = ["client"], optional = true }
-# TODO look into what their features do. the ones they have enabled by default seem important
-async-std = { version = "1.6", optional = true }
-
-# tokio has its own AsyncWrite+AsyncRead
-tokio            = { version = "0.3", features = ["net"], optional = true }
-tokio-util       = { version = "0.4", features = ["compat"], optional = true }
-
-# rustls
-tokio-rustls     = { version = "0.20", optional = true }
-webpki-roots     = { version = "0.20", optional = true }
-
-# native-tls
-tokio-native-tls = { version = "0.2", optional = true }
-native-tls       = { version = "0.2", optional = true }
-
-# openssl
-tokio-openssl    = { version = "0.5", optional = true }
-openssl          = { version = "0.10", optional = true, features = ["v111"] }
-
-# for some test utilities
-async-mutex = { version = "1.4", optional = true }
-
-
-[dev-dependencies]
-anyhow         = "1.0.33"
-async-executor = { version = "1.3.0", default-features = false }
-serde_json     = "1.0.59"
-rmp-serde      = "0.14.4"
-
-[[example]]
-name = "message_parse"
-required-features = ["async"]
-
-[[example]]
-name = "smol_demo"
-required-features = ["smol", "async"]
-
-[[example]]
-name = "async_io_demo"
-required-features = ["async-io", "async"]
-
-[[example]]
-name = "async_std_demo"
-required-features = ["async-std", "async-std/attributes", "async"]
-
-[[example]]
-name = "tokio_demo"
-required-features = ["tokio/full", "tokio-util", "async"]
-
-[[example]]
-name = "simple_bot"
-required-features = ["smol", "async"]
-
+[patch.crates-io]
+twitchchat = { path = "twitchchat" }

README.md

@@ -4,83 +4,9 @@
 [![Crates][crates_badge]][crates]
 [![Actions][actions_badge]][actions]
 
-This crate provides a way to interact with [Twitch]'s chat.
+This crate provides a way to interact with [Twitch][twitch]'s chat.
 
-Along with parse messages as Rust types, it provides methods for sending messages.
-
-It also provides an 'event' loop which you can use to make a bot.
-
-## Opt-in features
-
-By default, this crate depends on zero external crates -- but it makes it rather limited in scope. It can just parse/decode/encode to standard trait types (`std::io::{Read, Write}`).
-
-To use the `AsyncRunner` (an async-event loop) you must able the `async` feature.
-
-**_NOTE_** This is a breaking change from `0.12` which had the async stuff enabled by default.
-
-```toml
-twitchchat = { version = "0.14", features = ["async"] }
-```
-
-To use a specific `TcpStream`/`TlStream` refer to the runtime table below.
-
-## Serde support
-
-To enable serde support, simply enable the optional `serde` feature
-
-## Runtime
-
-This crate is runtime agonostic. To use..
-
-| Read/Write provider                                        | Features                 |
-| ---------------------------------------------------------- | ------------------------ |
-| [`async_io`](https://docs.rs/async-io/latest/async_io/)    | `async-io`               |
-| [`smol`](https://docs.rs/smol/latest/smol/)                | `smol`                   |
-| [`async_std`](https://docs.rs/async-std/latest/async_std/) | `async-std`              |
-| [`tokio`](https://docs.rs/tokio/0.2/tokio/)                | `tokio` and `tokio-util` |
-
-### TLS
-
-If you want TLS supports, enable the above runtime and also enable the cooresponding features:
-
-| Read/Write provider                                        | Runtime     | Features                                             | TLS backend                |
-| ---------------------------------------------------------- | ----------- | ---------------------------------------------------- | -------------------------- |
-| [`async_io`](https://docs.rs/async-io/latest/async_io/)    | `async_io`  | `"async-tls"`                                        | [`rustls`][rustls]         |
-| [`smol`](https://docs.rs/smol/latest/smol/)                | `smol`      | `"async-tls"`                                        | [`rustls`][rustls]         |
-| [`async_std`](https://docs.rs/async-std/latest/async_std/) | `async_std` | `"async-tls"`                                        | [`rustls`][rustls]         |
-| [`tokio`](https://docs.rs/tokio/0.2/tokio/)                | `tokio`     | `"tokio-util"`, `"tokio-rustls"`, `"webpki-roots"`   | [`rustls`][rustls]         |
-| [`tokio`](https://docs.rs/tokio/0.2/tokio/)                | `tokio`     | `"tokio-util"`, `"tokio-native-tls"`, `"native-tls"` | [`native-tls`][native-tls] |
-| [`tokio`](https://docs.rs/tokio/0.2/tokio/)                | `tokio`     | `"tokio-util"`, `"tokio-openssl"`, `"openssl"`       | [`openssl`][openssl]       |
-
-[rustls]: https://docs.rs/rustls/0.18.1/rustls/
-[native-tls]: https://docs.rs/native-tls/0.2.4/native_tls/
-[openssl]: https://docs.rs/openssl/0.10/openssl/
-
-## Examples
-
-#### Using async_io to connect with..
-
-- [async_io_demo.rs](./examples/async_io_demo.rs)
-
-#### Using async_std to connect with..
-
-- [async_std_demo.rs](./examples/async_std_demo.rs)
-
-#### Using smol to connect with..
-
-- [smol_demo.rs](./examples/smol_demo.rs)
-
-#### Using tokio to connect with..
-
-- [tokio_demo.rs](./examples/tokio_demo.rs)
-
-#### How to use the crate as just a message parser(decoder)/encoder
-
-- [message_parse.rs](./examples/message_parse.rs)
-
-#### An a simple example of how one could built a bot with this
-
-- [simple_bot.rs](./examples/simple_bot.rs)
+# Note, This branch is a major WIP for the next (`v0.15.0`) release
 
 ## License