-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Siddharth Chandrasekaran <[email protected]>
- Loading branch information
Showing
1 changed file
with
13 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,23 @@ | ||
# LibOSDP-rs | ||
|
||
This project hosts cargo crates that add rust support for [LibOSDP][1] and other | ||
OSDP related tools. You can also take a look at the [documentation][2] for more | ||
details. | ||
[![Build CI][7]][8] [![Crates.io Version][3]][4] [![Crates.io Version][5]][6] | ||
|
||
This project hosts cargo crates that add rust support for [LibOSDP][1] in rust | ||
and other OSDP related tools such as osdpctl. You can also take a look at the | ||
[documentation][2] for more details. | ||
|
||
## Project structure: | ||
|
||
Repo structure: | ||
- `libosdp-sys` - Low level rust `-sys` crate for the C library. | ||
- `libosdp` - Safe wrapper around `libosdp-sys` to be consumed by rust projects. | ||
- `osdpctl` - A tool to create and manage OSDP devices. | ||
- `scripts` - Tools for developers working on this project. | ||
|
||
[1]: https://github.com/goToMain/libosdp | ||
[2]: https://libosdp.sidcha.dev/ | ||
[3]: https://img.shields.io/crates/v/libosdp?style=flat&logo=rust&logoColor=DDD&label=crate%20%3A%20libosdp&link=https%3A%2F%2Fcrates.io%2Fcrates%2Flibosdp | ||
[4]: https://crates.io/crates/libosdp | ||
[5]: https://img.shields.io/crates/v/libosdp?style=flat&logo=rust&logoColor=DDD&label=crate%20%3A%20libosdp-sys&link=https%3A%2F%2Fcrates.io%2Fcrates%2Flibosdp-sys | ||
[6]: https://crates.io/crates/libosdp-sys | ||
[7]: https://github.com/goToMain/libosdp-rs/actions/workflows/build-ci.yml/badge.svg | ||
[8]: https://github.com/goToMain/libosdp-rs/actions/workflows/build-ci.yml |