From 5373ee3e4075aa271116df7072a60461a161161b Mon Sep 17 00:00:00 2001
From: Jens Pots <jens@jenspots.com>
Date: Wed, 20 Nov 2024 21:12:35 +0100
Subject: [PATCH] docs: add section on submodules and token

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 66bc7f6..1e19c73 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,20 @@ brew install rdf-connect/orchestrator https://github.com/rdf-connect/orchestrato
 
 ## Contributors
 
+### Submodules
+
+The Protobuf declarations are available in a seperate repository. Make sure to initialize it's respective submodule, since otherwise your Gradle build will fail.
+
+```shell
+git submodule update --init --recursive
+```
+
+You can of course also use the `--recurse-submodules` switch with `git clone`.
+
+### Github Authentication
+
+Some of the pipelines found in this repository depend on repositories hosted on GitHub, requiring an authentication token. These can be configured using the environment variables listed in `.env.example`. It suffices to copy this file to `.env` and fill in the variables.
+
 ### Publishing
 
 This project automatically publishes Maven packages and a Docker image whenever the `projectVersion` field in [`gradle.properties`](./gradle.properties) is updated.