diff --git a/uapi/Cargo.toml b/uapi/Cargo.toml index 5fe951d5..ccab9c69 100644 --- a/uapi/Cargo.toml +++ b/uapi/Cargo.toml @@ -3,11 +3,11 @@ [package] name = "sentry-uapi" -version = "0.4.0" +version = "0.4.1" edition = "2021" -license = "Apache 2.0" +license = "Apache-2.0" description = "Sentry kernel user API implementation" -categories = ["os::api"] +categories = ["os", "no-std"] [dependencies] diff --git a/uapi/README.md b/uapi/README.md new file mode 100644 index 00000000..c41346b6 --- /dev/null +++ b/uapi/README.md @@ -0,0 +1,27 @@ + + +# UAPI for Outpost-OS Sentry kernel + +[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9667/badge)](https://www.bestpractices.dev/projects/9667) +[![Documentation Status](https://readthedocs.org/projects/outpost-sentry/badge/?version=latest)](https://outpost-sentry.readthedocs.io/en/latest/?badge=latest) +![GitHub Release](https://img.shields.io/github/v/release/outpost-os/sentry-kernel) +![GitHub License](https://img.shields.io/github/license/outpost-os/sentry-kernel) +[![REUSE status](https://api.reuse.software/badge/github.com/outpost-os/sentry-kernel)](https://api.reuse.software/info/github.com/outpost-os/sentry-kernel) + +sentry-uapi is the user API library that delivers a full access to the [Outpost-OS](https://github.com/outpost-os) Sentry kernel interface. + +This crate implement the low level interface to the Sentry kernel syscalls and associated system types: + +* **Data types** — Sentry-uapi provides a complete set of data types and + values that are required in order to properly exchange information with the Sentry kernel. +* **Sentry syscalls** — All syscall are defined, so that the kernel can be triggered easily. + Syscall usage can be found in this very crate documentation. + +This crate also support C bindings in order to allow the integration of C codebase into the +Outpost-OS operating system. + +More information about the overall Sentry kernel and Outpost-OS concepts are defined in +the [Sentry kernel general documentation](https://outpost-sentry.readthedocs.io/en/latest/).