Skip to content

Commit

Permalink
doc: Update URLs and other details after the migration
Browse files Browse the repository at this point in the history
Signed-off-by: Siddharth Chandrasekaran <[email protected]>
  • Loading branch information
sidcha committed Feb 20, 2024
1 parent b0a009a commit fa787cb
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 18 deletions.
4 changes: 2 additions & 2 deletions libosdp-sys/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ version = "0.1.5"
edition = "2021"
authors = ["Siddharth Chandrasekaran <[email protected]>"]
description = "Sys crate for https://github.com/goToMain/libosdp"
documentation = "https://docs.rs/libosdp-sys"
documentation = "https://docs.rs/libosdp"
homepage = "https://libosdp.sidcha.dev/"
readme = "README.md"
repository = "https://github.com/goToMain/libosdp-sys"
repository = "https://github.com/goToMain/libosdp-rs"
license = "Apache-2.0"
keywords = ["osdp", "libosdp", "acs", "sia", "weigand"]
categories = ["development-tools", "embedded"]
Expand Down
18 changes: 8 additions & 10 deletions libosdp-sys/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
# libosdp-sys

Rust `-sys` bindings to [goToMain/libosdp](https://github.com/goToMain/libosdp/tree/master/rust)
This crate hosts bindgen generated `-sys` bindings to [goToMain/libosdp][1]. It
tracks LibOSDP releases and uses the same version numbers to make it easy to
determine the underlying LibOSDP version.

This repo is used to produce the `libosdp-sys` crate. See
[libosdp](https://github.com/goToMain/libosdp) for more details
This crate is not intended to be directly consumed. Please take a look at
[libosdp][2] (see doc [here][3]) if you intend to use LibOSDP in your project.

## Building

```bash

git submodule update --init --recursive
cargo build
```
[1]: https://github.com/goToMain/libosdp
[2]: https://crates.io/crates/libosdp
[3]: https://docs.rs/libosdp
13 changes: 9 additions & 4 deletions libosdp/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# LibOSDP for Rust

This crate is a rust wrapper for [LibOSDP][1] - the most popular open source
library for creating Open Supervised Device Protocol (OSDP) devices. See
https://github.cobm/goToMain/liosdp for more information.
This crate provides safe wrappers for accessing the C library [LibOSDP][1].
LibOSDP the most popular open source library for creating Open Supervised Device
Protocol (OSDP) devices. For more information about the library or OSDP in
general, see [libosdp.sidcha.dev][4].

The documentation for this crate can be found [here][5].

## Features

Expand Down Expand Up @@ -56,5 +59,7 @@ loop {
See [examples][2] for a working implementation.

[1]: https://github.cobm/goToMain/liosdp
[2]: https://github.com/goToMain/libosdp/blob/master/rust/examples
[2]: https://github.com/goToMain/libosdp-rs/tree/master/libosdp/examples
[3]: https://libosdp.sidcha.dev/protocol/commands-and-replies
[4]: https://libosdp.sidcha.dev/
[5]: https://docs.rs/libosdp
4 changes: 2 additions & 2 deletions osdpctl/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ version = "0.1.0"
edition = "2021"
authors = ["Siddharth Chandrasekaran <[email protected]>"]
description = "Tool to help setup, manage and control OSDP devices"
documentation = "https://libosdp.sidcha.dev/osdpctl"
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", "osdpctl"]
categories = ["development-tools", "embedded"]
Expand Down

0 comments on commit fa787cb

Please sign in to comment.