PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-22 20:32:05 +01:00
Code Issues Releases Wiki Activity

Document how to include pgpainless-sop in build scripts

Browse source
This commit is contained in:
Paul Schaub 2022-01-15 14:38:36 +01:00
parent 7aa48f458b
commit 593a6cdb65
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
pgpainless-sop/README.md
View file

@ -16,6 +16,33 @@ Implementation of the Stateless OpenPGP Protocol using PGPainless.
This module implements `sop-java` using `pgpainless-core`.
If your code depends on `sop-java`, this module can be used as a realization of those interfaces.
## Get started
To start using pgpainless-sop in your code, include the following lines in your build script:
```
// If you use Gradle
...
dependencies {
...
implementation "org.pgpainless:pgpainless-sop:1.1.0"
...
}
// If you use Maven
...
<dependencies>
...
<dependency>
<groupId>org.pgpainless</groupId>
<artifactId>pgpainless-sop</artifactId>
<version>1.1.0</version>
</dependency>
...
</dependencies>
```
`pgpainless-sop` will transitively pull in its dependencies, such as `sop-java` and `pgpainless-core`.
## Usage Examples
```java
SOP sop = new SOPImpl();