README.adoc

// SPDX-FileCopyrightText: 2023 Shun Sakai // // SPDX-License-Identifier: CC-BY-4.0

= abcrypt :project-url: https://github.com/sorairolake/abcrypt :shields-url: https://img.shields.io :crates-io-url: https://crates.io :crates-io-crates: {crates-io-url}/crates :npm-url: https://www.npmjs.com :npm-package: {npm-url}/package :pypi-url: https://pypi.org :pypi-project: {pypi-url}/project :ci-badge: {shields-url}/github/actions/workflow/status/sorairolake/abcrypt/CI.yaml?branch=develop&style=for-the-badge&logo=github&label=CI :ci-url: {project-url}/actions?query=branch%3Adevelop+workflow%3ACI++ :abcrypt-repo-url: {project-url}/tree/develop/crates/abcrypt :abcrypt-badge: {shields-url}/crates/v/abcrypt?style=for-the-badge&logo=rust :abcrypt-crates-io: {crates-io-crates}/abcrypt :abcrypt-cli-repo-url: {project-url}/tree/develop/crates/cli :abcrypt-cli-badge: {shields-url}/crates/v/abcrypt-cli?style=for-the-badge&logo=rust :abcrypt-cli-crates-io: {crates-io-crates}/abcrypt-cli :abcrypt-capi-repo-url: {project-url}/tree/develop/crates/capi :abcrypt-wasm-repo-url: {project-url}/tree/develop/crates/wasm :abcrypt-wasm-badge: {shields-url}/npm/v/%40sorairolake%2Fabcrypt-wasm?style=for-the-badge&logo=npm :abcrypt-wasm-npm: {npm-package}/@sorairolake/abcrypt-wasm :abcrypt-py-repo-url: {project-url}/tree/develop/crates/python :abcrypt-py-badge: {shields-url}/pypi/v/abcrypt-py?style=for-the-badge&logo=pypi :abcrypt-py-pypi: {pypi-project}/abcrypt-py/ :reuse-spec-url: https://reuse.software/spec-3.3/

image:{ci-badge}[CI,link={ci-url}]

abcrypt is a simple, modern and secure file encryption tool, file format and Rust library.

image::crates/cli/assets/demo.gif[Demo animation]

== Crates

|=== |Name |Version |Description

|{abcrypt-repo-url}[abcrypt] |image:{abcrypt-badge}[Version,link={abcrypt-crates-io}] |The abcrypt encrypted data format reference implementation.

|{abcrypt-cli-repo-url}[abcrypt-cli] |image:{abcrypt-cli-badge}[Version,link={abcrypt-cli-crates-io}] |File encryption tool using the abcrypt encrypted data format.

|{abcrypt-capi-repo-url}[abcrypt-capi] | |C API for abcrypt.

|{abcrypt-wasm-repo-url}[abcrypt-wasm] |image:{abcrypt-wasm-badge}[Version,link={abcrypt-wasm-npm}] |Wasm bindings for abcrypt.

|{abcrypt-py-repo-url}[abcrypt-py] |image:{abcrypt-py-badge}[Version,link={abcrypt-py-pypi}] |Python bindings for abcrypt. |===

== Format specification

The format specification is at link:docs/spec/FORMAT.adoc[FORMAT.adoc].

== Source code

The upstream repository is available at https://github.com/sorairolake/abcrypt.git.

== Contributing

Please see link:CONTRIBUTING.adoc[].

== Home page

https://sorairolake.github.io/abcrypt/

== License

Copyright (C) 2023 Shun Sakai (see link:AUTHORS.adoc[])

. Unless otherwise noted, each file is distributed under the terms of either the Apache License 2.0 or the MIT License. . Each file in the crates/cli directory and some other files are distributed under the terms of the GNU General Public License v3.0 or later. . The format specification is distributed under the terms of the CC0 1.0 Universal. . Some documents are distributed under the terms of the Creative Commons Attribution 4.0 International Public License.

This project is compliant with version 3.3 of the {reuse-spec-url}[REUSE Specification]. See copyright notices of individual files for more details on copyright and licensing information.