PGPainless 1.0.0-rc1

CHANGELOG.md

@@ -5,6 +5,17 @@ SPDX-License-Identifier: CC0-1.0
 
 # PGPainless Changelog
 
+## 1.0.0-rc1
+- First release candidate for a 1.0.0 release! \o/
+- Rename `EncryptionPurpose.STORAGE_AND_COMMUNICATIONS` to `EncryptionPurpose.ANY`
+- Hide `PGPainless.verifyCleartextSignedMessage()` behind `PGPainless.decryptAndVerify()`.
+  - the latter now checks whether the message is cleartext-signed or not and automatically calls the proper API
+  - `MultiPassStrategy` objects are now set through `ConsumerOptions.setMultiPassStrategy()`.
+- Separate key ring generation through templates from custom key ring builder
+  - `PGPainless.generateKeyRing()` now offers to generate keys from templates
+  - `PGPainless.buildKeyRing()` offers a detailed API to build custom keys
+- Fix detection of non-armored data
+
 ## 0.2.19
 - Some preparations for OpenPGP V5 keys: `OpenPgpV4Fingerprint` is now an implementation of `OpenPgpFingerprint`
 - `SignatureVerification` and `Failure` now have `toString()` implementations

README.md

@@ -129,6 +129,9 @@ Still it allows you to manually specify which algorithms to use of course.
 
         Streams.pipeAll(plaintextInputStream, encryptionStream);
         encryptionStream.close();
+
+        // Information about the encryption (algorithms, detached signatures etc.)
+        EncryptionResult result = encryptionStream.getResult();
 ```
 
 ### Decrypt and Verify Signatures
@@ -170,18 +173,19 @@ repositories {
 }
 
 dependencies {
-	implementation 'org.pgpainless:pgpainless-core:0.2.19'
+	implementation 'org.pgpainless:pgpainless-core:1.0.0-rc1'
 }
 ```
 
 ## About
-PGPainless is a by-product of my [Summer of Code 2018 project](https://blog.jabberhead.tk/summer-of-code-2018/).
+PGPainless is a by-product of my [Summer of Code 2018 project](https://blog.jabberhead.tk/summer-of-code-2018/)
+implementing OpenPGP support for the XMPP client library [Smack](https://github.com/igniterealtime/Smack).
 For that project I was in need of a simple to use OpenPGP library.
 
 Originally I was going to use [Bouncy-GPG](https://github.com/neuhalje/bouncy-gpg) for my project,
 but ultimately I decided to create my own OpenPGP library which better fits my needs.
 
-However, PGPainless is heavily influenced by Bouncy-GPG.
+However, PGPainless was heavily influenced by Bouncy-GPG.
 
 To reach out to the development team, feel free to send a mail: info@pgpainless.org
 

version.gradle

@@ -4,8 +4,8 @@
 
 allprojects {
     ext {
-        shortVersion = '0.2.20'
-        isSnapshot = true
+        shortVersion = '1.0.0-rc1'
+        isSnapshot = false
         pgpainlessMinAndroidSdk = 10
         javaSourceCompatibility = 1.8
         bouncyCastleVersion = '1.69'