Merge pull request #11 from CommanderStorm/documented-examples

Fixed a few `Cargo.toml` fields
goToMain · Aug 18, 2024 · d2751f0 · d2751f0
2 parents 9409f70 + 7d5e9e2
commit d2751f0
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/libosdp-sys/Cargo.toml b/libosdp-sys/Cargo.toml
@@ -4,7 +4,7 @@ version = "3.0.6"
 edition = "2021"
 authors = ["Siddharth Chandrasekaran <sidcha.dev@gmail.com>"]
 description = "Sys crate for https://github.com/goToMain/libosdp"
-documentation = "https://docs.rs/libosdp"
+documentation = "https://docs.rs/libosdp-sys"
 homepage = "https://libosdp.sidcha.dev/"
 readme = "README.md"
 repository = "https://github.com/goToMain/libosdp-rs"

diff --git a/libosdp/Cargo.toml b/libosdp/Cargo.toml
@@ -7,7 +7,7 @@ description = "Library implementation of IEC 60839-11-5 OSDP (Open Supervised De
 documentation = "https://docs.rs/libosdp"
 homepage = "https://libosdp.sidcha.dev/"
 readme = "README.md"
-repository = "https://github.com/goToMain/libosdp"
+repository = "https://github.com/goToMain/libosdp-rs"
 license = "Apache-2.0"
 keywords = ["osdp", "libosdp", "acs", "sia", "weigand"]
 categories = ["development-tools", "embedded"]
@@ -30,3 +30,11 @@ sha256 = "1.5.0"
 [features]
 default = ["std"]
 std = ["thiserror"]
+
+[[example]]
+name = "cp"
+required-features = ["std"]
+
+[[example]]
+name = "pd"
+required-features = ["std"]
diff --git a/osdpctl/Cargo.toml b/osdpctl/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.0.1"
 edition = "2021"
 authors = ["Siddharth Chandrasekaran <sidcha.dev@gmail.com>"]
 description = "Tool to help setup, manage and control OSDP devices"
-documentation = "https://docs.rs/libosdp"
+documentation = "https://libosdp.sidcha.dev/osdpctl/introduction.html"
 homepage = "https://libosdp.sidcha.dev/"
 readme = "README.md"
 repository = "https://github.com/goToMain/libosdp-rs"