From 2c4131369d0b54fd068fd89efea4ef38999ba754 Mon Sep 17 00:00:00 2001 From: Tim <0xtimc@gmail.com> Date: Wed, 16 Oct 2024 21:05:48 +0100 Subject: [PATCH 1/2] Add initial DocC scaffolding --- Sources/Crypto/Docs.docc/index.md | 12 ++++++++++++ Sources/_CryptoExtras/Docs.docc/index.md | 5 +++++ 2 files changed, 17 insertions(+) create mode 100644 Sources/Crypto/Docs.docc/index.md create mode 100644 Sources/_CryptoExtras/Docs.docc/index.md diff --git a/Sources/Crypto/Docs.docc/index.md b/Sources/Crypto/Docs.docc/index.md new file mode 100644 index 000000000..e44b543b6 --- /dev/null +++ b/Sources/Crypto/Docs.docc/index.md @@ -0,0 +1,12 @@ +# ``Crypto`` + +A cryptography library for Swift. + +## Overview + +Swift Crypto provides a Swift library for common cryptographic operations. It is available as a Swift package and provides two main libraries: + +* `Crypto` - an open-source implementation of a substantial portion of the API of [Apple CryptoKit](https://developer.apple.com/documentation/cryptokit) suitable for use on Linux platforms. It enables cross-platform or server applications with the advantages of CryptoKit. +* `CryptoExtras` - a collection of additional cryptographic primitives and utilities that are not part of CryptoKit but useful in a server environment. + +Swift Crypto is built on top of [BoringSSL](https://boringssl.googlesource.com/boringssl/), Google's fork of OpenSSL. The current features of Swift Crypto cover key exchange, key derivation, encryption and decryption, hashing, message authentication, and more. \ No newline at end of file diff --git a/Sources/_CryptoExtras/Docs.docc/index.md b/Sources/_CryptoExtras/Docs.docc/index.md new file mode 100644 index 000000000..310cf0dd9 --- /dev/null +++ b/Sources/_CryptoExtras/Docs.docc/index.md @@ -0,0 +1,5 @@ +# ``CryptoExtras`` + +Provides additional cryptographic APIs that are not available in CryptoKit (and therefore the core Crypto library). + + From 5d737fe38b6e2615ac48344e28cfe64c22cdd5bb Mon Sep 17 00:00:00 2001 From: Tim <0xtimc@gmail.com> Date: Wed, 16 Oct 2024 21:06:36 +0100 Subject: [PATCH 2/2] Add SPI file --- .spi.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.spi.yml b/.spi.yml index f84c610c1..f07df0065 100644 --- a/.spi.yml +++ b/.spi.yml @@ -1,4 +1,4 @@ version: 1 builder: configs: - - documentation_targets: [Crypto] + - documentation_targets: [Crypto, _CryptoExtras]