Skip to content

Commit

Permalink
doc: Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Siddharth Chandrasekaran <[email protected]>
  • Loading branch information
sidcha committed Feb 17, 2024
1 parent d92ac67 commit edaa61c
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
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

0 comments on commit edaa61c

Please sign in to comment.