From 593a6cdb6595b1c6383d28ea2c0999244cc5b4c8 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Sat, 15 Jan 2022 14:38:36 +0100
Subject: [PATCH] Document how to include pgpainless-sop in build scripts

---
 pgpainless-sop/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/pgpainless-sop/README.md b/pgpainless-sop/README.md
index 067f85c8..3de168c3 100644
--- a/pgpainless-sop/README.md
+++ b/pgpainless-sop/README.md
@@ -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();