From 5d273fee6c0cb04d848155539bac7f79caec4082 Mon Sep 17 00:00:00 2001
From: TobiasNx <tobias.buelte@hbz-nrw.de>
Date: Tue, 5 Sep 2023 12:17:43 +0200
Subject: [PATCH] Update the getting started page

---
 getting-started.md | 37 +++++++++++++++++++++++++++++++++++--
 1 file changed, 35 insertions(+), 2 deletions(-)

diff --git a/getting-started.md b/getting-started.md
index e0ad559..6dee4d9 100644
--- a/getting-started.md
+++ b/getting-started.md
@@ -10,7 +10,7 @@ The easiest way to get started with Metafacture is the Playground. Take a look a
 
 For commands available in the Flux, see [the Flux commands documentation](https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md).
 
-For functions and usage of the Fix, see [the Fix functions and cookbook](https://github.com/metafacture/metafacture-fix#functions-and-cookbook).
+For functions and usage of the Fix, see [the Fix functions and cookbook](https://github.com/metafacture/metafacture-documentation/blob/master/Fix-function-and-Cookbook.md).
 
 ## Command line
 
@@ -23,6 +23,39 @@ To get started, you can export a workflow from the Playground (last button, !["E
 
 To set up IDE support for editing your Flux and Fix files, see [the IDE extensions page](/ide-extensions/index.html).
 
+## Using Metafacture as a Java library
+
+If you want to use Metafacture in your own Java projects all you need is to add some dependencies to your project. As of Metafacture 5, the single metafacture-core package has been replaced with a number of domain-specific packages. You can find the list of packages on [Maven Central](https://search.maven.org/search?q=g:org.metafacture).
+
+Alternatively, you can simply guess the package names from the top-level folders in the source code repository -- they are the same. 
+
+For instance, if you want to use the `metafacture-io` library in your project, simply add the following dependency to your `pom.xml`:
+
+```xml
+<dependency>
+    <groupId>org.metafacture</groupId>
+    <artifactId>metafacture-io</artifactId>
+    <version>$VERSION</version>
+</dependency>
+```
+
+or if Gradle is your build tool of choice use:
+
+```groovy
+dependencies {
+    implementation 'org.metafacture:metafacture-io:$VERSION'
+}
+```
+
+To use Fix you would declare `metafix` instead of `metafacture-io` as in the example above. Note that `metafix` is not published to maven central but only to [github releases](https://github.com/metafacture/metafacture-fix/releases).
+
+Occasionally, we publish snapshot builds on [Sonatype OSS Repository](https://oss.sonatype.org/index.html#nexus-search;gav~org.metafacture~~~~~kw,versionexpand). The version number is derived from the branch name. Snapshot builds from the master branch always have the version `master-SNAPSHOT`. We also provide sometimes pre releases as github packages.
+
 ## Next steps
 
-For a complete introduction to Metafacture in German, check out the latest iteration of [our Metafacture Workshop](https://slides.lobid.org/2022-12-metafacture-workshop/#/). For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see [our documentation collection](https://github.com/metafacture/metafacture-documentation).
+Get familar with [FLUX](https://github.com/metafacture/metafacture-documentation/blob/master/Flux-User-Guide.md) and [FIX](https://github.com/metafacture/metafacture-documentation/blob/master/Fix-User-Guide.md). And try out some Metafacture workflows.
+
+If you plan to use Metafacture as a Java library or if you wish to add commands to Flux you should get familar with the [Framework](https://github.com/metafacture/metafacture-documentation/blob/master/Framework-User-Guide.md).
+
+For a complete introduction to Metafacture in German, check out the latest iteration of [our Metafacture Workshop](https://slides.lobid.org/2022-12-metafacture-workshop/#/). 
+For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see [our documentation collection](https://github.com/metafacture/metafacture-documentation).