docs: added description to lib.rs

JadKHaddad · JadKHaddad · commit 18259b696d49 · 2025-07-18T20:34:47.000+02:00
Signed-off-by: Jad K. Haddad &lt;jadkhaddad@gmail.com&gt;
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -33,7 +33,7 @@ http-body-util = "0.1.3"
 bytes = "1.10.1"
 hyper = "1.6.0"
 futures = "0.3.31"
-hyper-util = "0.1.14"
+hyper-util = "0.1.15"
 
 [profile.release]
 opt-level = 3
diff --git a/README.md b/README.md
@@ -10,8 +10,6 @@
 
 `zerocopy`, `async`, `no_std` and [`autobahn`](https://github.com/crossbario/autobahn-testsuite) compliant `websockets` implementation.
 
-## WIP
-
 ## License
 
 Licensed under either of
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,3 +1,5 @@
+//! `zerocopy`, `async`, `no_std` and [`autobahn`](https://github.com/crossbario/autobahn-testsuite) compliant `websockets` implementation.
+
 #![no_std]
 #![deny(missing_debug_implementations)]
 // #![deny(missing_docs)]

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	+//! `zerocopy`, `async`, `no_std` and [`autobahn`](https://github.com/crossbario/autobahn-testsuite) compliant `websockets` implementation.
	`2`	`+`
`1`	`3`	`#![no_std]`
`2`	`4`	`#![deny(missing_debug_implementations)]`
`3`	`5`	`// #![deny(missing_docs)]`