Skip to content

Commit 4b38f35

Browse files
committed
Update README
1 parent 5f9bcf6 commit 4b38f35

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,26 @@ liboqs-python
55

66
---
77

8-
**liboqs-python** offers a Python module wrapping the [Open Quantum Safe](https://openquantumsafe.org/) [liboqs](https://github.com/open-quantum-safe/liboqs/) C library, which is a C library for quantum-resistant cryptographic algorithms.
8+
**liboqs-python** offers a Python module providing quantum-resistant cryptographic algorithms via liboqs.
99

10-
## Pre-requisites
10+
Overview
11+
--------
12+
13+
The **Open Quantum Safe (OQS) project** has the goal of developing and prototyping quantum-resistant cryptography.
14+
15+
**liboqs** is an open source C library for quantum-resistant cryptographic algorithms. See more about liboqs at [https://github.com/open-quantum-safe/liboqs/](https://github.com/open-quantum-safe/liboqs/), including a list of supported algorithms.
16+
17+
**liboqs-python** is an open source Python 3 wrapper for the liboqs C library. liboqs-python provides:
18+
19+
- a common API for post-quantum key encapsulation mechanisms and digital signature schemes
20+
- a collection of open source implementations of post-quantum cryptography algorithms
21+
22+
The OQS project also provides prototype integrations into application-level protocols to enable testing of quantum-resistant cryptography.
23+
24+
More information on OQS can be found on our website: [https://openquantumsafe.org/](https://openquantumsafe.org/).
25+
26+
Pre-requisites
27+
--------------
1128

1229
liboqs-python depends on the [liboqs](https://github.com/open-quantum-safe/liboqs) C library; liboqs master branch must first be compiled as a Linux/macOS/Windows library, see the specific platform building instructions below.
1330

0 commit comments

Comments
 (0)