From 56abb5175778ba44f4ef609515680ab8a46e9997 Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Tue, 12 Jul 2022 08:49:30 +0200 Subject: [PATCH] Small formatting changes of doc index --- docs/source/index.rst | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 362d340d..a29e6c03 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,17 +1,23 @@ PGPainless - Painless OpenPGP ============================= -**OpenPGP** (`RFC 4480 `_) is an Internet Standard mostly used for email encryption. +**OpenPGP** (`RFC 4480 `_) is an Internet Standard mostly used for email +encryption. It provides mechanisms to ensure *confidentiality*, *integrity* and *authenticity* of messages. -However, OpenPGP can also be used for other purposes, such as secure messaging or as a signature mechanism for software distribution. +However, OpenPGP can also be used for other purposes, such as secure messaging or as a signature mechanism for +software distribution. -**PGPainless** strives to improve the (currently pretty dire) state of the ecosystem of Java libraries and tooling for OpenPGP. +**PGPainless** strives to improve the (currently pretty dire) state of the ecosystem of Java libraries and tooling +for OpenPGP. The library focuses on being easy and intuitive to use without getting into your way. -Common functions such as creating keys, encrypting data, and so on are implemented using a builder structure that guides you through the necessary steps. +Common functions such as creating keys, encrypting data, and so on are implemented using a builder structure that +guides you through the necessary steps. -Internally, it is based on `Bouncy Castles `_ mighty, but low-level OpenPGP API. -PGPainless' goal is to empower you to use OpenPGP without needing to write all the boilerplate code required by Bouncy Castle. +Internally, it is based on `Bouncy Castles `_ mighty, but low-level ``bcpg`` +OpenPGP API. +PGPainless' goal is to empower you to use OpenPGP without needing to write all the boilerplate code required by +Bouncy Castle. It aims to be secure by default while allowing customization if required.