diff options
| author | hozan23 <hozan23@proton.me> | 2023-11-23 00:13:27 +0300 |
|---|---|---|
| committer | hozan23 <hozan23@proton.me> | 2023-11-23 00:13:27 +0300 |
| commit | ca2a5f8bbb6983d9555abd10eaaf86950b794957 (patch) | |
| tree | d841bbf1b7ef3a816dc75ac59bd81eceac350c63 | |
| parent | f1b78d53d7d0009fdef8f0e220bc0c421288c514 (diff) | |
update README.md
| -rw-r--r-- | README.md | 15 | ||||
| -rw-r--r-- | core/src/lib.rs | 2 | ||||
| -rw-r--r-- | jsonrpc/src/server.rs | 2 | ||||
| -rw-r--r-- | net/src/connection.rs | 4 |
4 files changed, 10 insertions, 13 deletions
@@ -31,15 +31,13 @@ including TLS implementation. You can check the ## Docs -Online documentation for the main crates: +Online documentation for the main crates: +[karyons_p2p](https://karyons.github.io/karyons/karyons_p2p), +[karyons_jsonrpc](https://karyons.github.io/karyons/karyons_jsonrpc) -- [karyons_p2p](https://karyons.github.io/karyons/karyons_p2p) -- [karyons_jsonrpc](https://karyons.github.io/karyons/karyons_jsonrpc) - -For the internal crates: - -- [karyons_core](https://karyons.github.io/karyons/karyons_core) -- [karyons_net](https://karyons.github.io/karyons/karyons_net) +For the internal crates: +[karyons_core](https://karyons.github.io/karyons/karyons_core), +[karyons_net](https://karyons.github.io/karyons/karyons_net) ## Thanks @@ -56,4 +54,3 @@ Feel free to open a pull request or an [issue](https://github.com/karyons/karyon All the code in this repository is licensed under the GNU General Public License, version 3 (GPL-3.0). You can find a copy of the license in the [LICENSE](./LICENSE) file. - diff --git a/core/src/lib.rs b/core/src/lib.rs index 6c40909..67e6610 100644 --- a/core/src/lib.rs +++ b/core/src/lib.rs @@ -8,7 +8,7 @@ pub mod async_utils; /// Represents karyons's Core Error. pub mod error; -/// [`event::EventSys`] Implementation +/// [`event::EventSys`] Implementation pub mod event; /// A simple publish-subscribe system [`Read More`](./pubsub/struct.Publisher.html) diff --git a/jsonrpc/src/server.rs b/jsonrpc/src/server.rs index 213fa41..5b9b799 100644 --- a/jsonrpc/src/server.rs +++ b/jsonrpc/src/server.rs @@ -16,7 +16,7 @@ use crate::{ Error, Result, JSONRPC_VERSION, }; -/// RPC server config +/// RPC server config #[derive(Default)] pub struct ServerConfig { codec_config: CodecConfig, diff --git a/net/src/connection.rs b/net/src/connection.rs index 950f171..d8ec0a3 100644 --- a/net/src/connection.rs +++ b/net/src/connection.rs @@ -9,8 +9,8 @@ pub type Conn = Box<dyn Connection>; /// Connection is a generic network connection interface for /// [`udp::UdpConn`], [`tcp::TcpConn`], and [`unix::UnixConn`]. /// -/// If you are familiar with the Go language, this is similar to the -/// [Conn](https://pkg.go.dev/net#Conn) interface +/// If you are familiar with the Go language, this is similar to the +/// [Conn](https://pkg.go.dev/net#Conn) interface #[async_trait] pub trait Connection: Send + Sync { /// Returns the remote peer endpoint of this connection |