Metadata for easier searching on crates.io

ivmarkov · Jan 27, 2024 · 5e8abe9 · 5e8abe9
1 parent 88bd771
commit 5e8abe9
Show file tree

Hide file tree

Showing 11 changed files with 99 additions and 2 deletions.
diff --git a/edge-captive/Cargo.toml b/edge-captive/Cargo.toml
@@ -3,6 +3,17 @@ name = "edge-captive"
 version = "0.1.0"
 edition = "2021"
 rust-version = "1.75"
+description = "Async + `no_std` + no-alloc implementation of a Captive Portal DNS"
+repository = "https://github.com/ivmarkov/edge-net"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+categories = [
+    "embedded",
+    "no-std",
+    "asynchronous",
+    "networking",
+    "dns"
+]
 
 [features]
 default = ["io"]

diff --git a/edge-dhcp/Cargo.toml b/edge-dhcp/Cargo.toml
@@ -3,6 +3,17 @@ name = "edge-dhcp"
 version = "0.1.0"
 edition = "2021"
 rust-version = "1.75"
+description = "Async + `no_std` + no-alloc implementation of the DHCP protocol"
+repository = "https://github.com/ivmarkov/edge-net"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+categories = [
+    "embedded",
+    "no-std",
+    "asynchronous",
+    "networking",
+    "dhcp"
+]
 
 [features]
 default = ["io"]

diff --git a/edge-http/Cargo.toml b/edge-http/Cargo.toml
@@ -3,6 +3,17 @@ name = "edge-http"
 version = "0.1.0"
 edition = "2021"
 rust-version = "1.75"
+description = "Async + `no_std` + no-alloc implementation of the HTTP protocol"
+repository = "https://github.com/ivmarkov/edge-net"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+categories = [
+    "embedded",
+    "no-std",
+    "asynchronous",
+    "networking",
+    "http"
+]
 
 [features]
 default = ["io"]

diff --git a/edge-mdns/Cargo.toml b/edge-mdns/Cargo.toml
@@ -2,6 +2,17 @@
 name = "edge-mdns"
 version = "0.1.0"
 edition = "2021"
+description = "Async + `no_std` + no-alloc implementation of an mDNS responder"
+repository = "https://github.com/ivmarkov/edge-net"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+categories = [
+    "embedded",
+    "no-std",
+    "asynchronous",
+    "networking",
+    "mdns"
+]
 
 [features]
 default = ["io"]

diff --git a/edge-mqtt/Cargo.toml b/edge-mqtt/Cargo.toml
@@ -3,6 +3,17 @@ name = "edge-mqtt"
 version = "0.1.0"
 edition = "2021"
 rust-version = "1.75"
+description = "Implements the embedded-svc MQTT traits on top of the rumqttc crate"
+repository = "https://github.com/ivmarkov/edge-net"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+categories = [
+    "embedded",
+    "no-std",
+    "asynchronous",
+    "networking",
+    "mqtt"
+]
 
 [dependencies]
 rumqttc = "0.23"

diff --git a/edge-mqtt/README.md b/edge-mqtt/README.md
@@ -4,7 +4,7 @@
 ![crates.io](https://img.shields.io/crates/v/edge-net.svg)
 [![Documentation](https://docs.rs/edge-net/badge.svg)](https://docs.rs/edge-net)
 
-A wrapper for the [`rumqttc`]() crate that adapts it to async [MQTT traits]() of the `embedded-svc` crate.
+A wrapper for the [`rumqttc`](https://github.com/bytebeamio/rumqtt) crate that adapts it to the async [MQTT traits](https://github.com/esp-rs/embedded-svc/blob/master/src/mqtt/client.rs) of the `embedded-svc` crate.
 
 **NOTE**: Needs STD!
 

diff --git a/edge-raw/Cargo.toml b/edge-raw/Cargo.toml
@@ -3,6 +3,17 @@ name = "edge-raw"
 version = "0.1.0"
 edition = "2021"
 rust-version = "1.75"
+description = "Async + `no_std` + no-alloc implementation of IP and UDP packet creation and parsing"
+repository = "https://github.com/ivmarkov/edge-net"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+categories = [
+    "embedded",
+    "no-std",
+    "asynchronous",
+    "networking",
+    "ip"
+]
 
 [features]
 default = ["io"]

diff --git a/edge-std-nal-async/Cargo.toml b/edge-std-nal-async/Cargo.toml
@@ -3,6 +3,16 @@ name = "edge-std-nal-async"
 version = "0.1.0"
 edition = "2021"
 rust-version = "1.75"
+description = "A stop-gap STD implementation of embedded-nal-async, and embedded-nal-async-xtra"
+repository = "https://github.com/ivmarkov/edge-net"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+categories = [
+    "embedded",
+    "no-std",
+    "asynchronous",
+    "networking"
+]
 
 [dependencies]
 embedded-io-async = { workspace = true, features = ["std"] }

diff --git a/edge-ws/Cargo.toml b/edge-ws/Cargo.toml
@@ -3,6 +3,17 @@ name = "edge-ws"
 version = "0.1.0"
 edition = "2021"
 rust-version = "1.75"
+description = "Async + `no_std` + no-alloc implementation of the Websockets protocol"
+repository = "https://github.com/ivmarkov/edge-net"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+categories = [
+    "embedded",
+    "no-std",
+    "asynchronous",
+    "networking",
+    "websockets"
+]
 
 [features]
 default = ["io"]

diff --git a/embedded-nal-async-xtra/Cargo.toml b/embedded-nal-async-xtra/Cargo.toml
@@ -3,6 +3,16 @@ name = "embedded-nal-async-xtra"
 version = "0.1.0"
 edition = "2021"
 rust-version = "1.75"
+description = "Hosts a bunch of traits which are not yet available in the embedded-nal-async crate"
+repository = "https://github.com/ivmarkov/edge-net"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+categories = [
+    "embedded",
+    "no-std",
+    "asynchronous",
+    "networking"
+]
 
 [dependencies]
 embedded-io-async = { workspace = true }

diff --git a/embedded-nal-async-xtra/README.md b/embedded-nal-async-xtra/README.md
@@ -4,7 +4,7 @@
 ![crates.io](https://img.shields.io/crates/v/edge-net.svg)
 [![Documentation](https://docs.rs/edge-net/badge.svg)](https://docs.rs/edge-net)
 
-A placeholder for a bunch of traits which hopefully will be upstreamed into [embedded-nal-async](https://github.com/rust-embedded-community/embedded-nal/tree/master/embedded-nal-async) soon - in one shape or another.
+Hosts a bunch of traits which hopefully will be upstreamed into [embedded-nal-async](https://github.com/rust-embedded-community/embedded-nal/tree/master/embedded-nal-async) soon - in one shape or another.
 
 ## Justification