<!--
SPDX-FileCopyrightText: 2022 Shun Sakai

SPDX-License-Identifier: Apache-2.0 OR MIT
-->

# C API for abcrypt

[![CI][ci-badge]][ci-url]
[![Version][version-badge]][version-url]
![MSRV][msrv-badge]
[![Docs][docs-badge]][docs-url]
![License][license-badge]

**abcrypt-capi** exposes a C API for the [`abcrypt`] crate.

## Usage

### Build

```sh
cargo build
```

This will produce static and shared C libraries.

### Header file

[`abcrypt.h`] is automatically generated by the [`cbindgen`] crate.

### Documentation

See the [documentation][docs-url] for more details.

#### Manual pages

To find the directory where manual pages are generated:

```sh
fd -t directory out ./target/*/build/abcrypt-capi-*
```

## Minimum supported Rust version

The minimum supported Rust version (MSRV) of this library is v1.74.0.

## Changelog

Please see [CHANGELOG.adoc].

## Contributing

Please see [CONTRIBUTING.adoc].

## License

Copyright &copy; 2022&ndash;2024 Shun Sakai (see [AUTHORS.adoc])

This library is distributed under the terms of either the _Apache License 2.0_
or the _MIT License_.

This project is compliant with version 3.0 of the [_REUSE Specification_]. See
copyright notices of individual files for more details on copyright and
licensing information.

[ci-badge]: https://img.shields.io/github/actions/workflow/status/sorairolake/abcrypt/CI.yaml?branch=develop&style=for-the-badge&logo=github&label=CI
[ci-url]: https://github.com/sorairolake/abcrypt/actions?query=branch%3Adevelop+workflow%3ACI++
[version-badge]: https://img.shields.io/crates/v/abcrypt-capi?style=for-the-badge&logo=rust
[version-url]: https://crates.io/crates/abcrypt-capi
[msrv-badge]: https://img.shields.io/crates/msrv/abcrypt-capi?style=for-the-badge&logo=rust
[docs-badge]: https://img.shields.io/docsrs/abcrypt-capi?style=for-the-badge&logo=docsdotrs&label=Docs.rs
[docs-url]: https://docs.rs/abcrypt-capi
[license-badge]: https://img.shields.io/crates/l/abcrypt-capi?style=for-the-badge
[`abcrypt`]: https://crates.io/crates/abcrypt
[`abcrypt.h`]: include/abcrypt.h
[`cbindgen`]: https://crates.io/crates/cbindgen
[CHANGELOG.adoc]: CHANGELOG.adoc
[CONTRIBUTING.adoc]: ../../CONTRIBUTING.adoc
[AUTHORS.adoc]: ../../AUTHORS.adoc
[_REUSE Specification_]: https://reuse.software/spec/