Commit 74eb16bc authored by Gradl, Tobias's avatar Gradl, Tobias
Browse files

12: Compose some initial documentation

Task-Url: #12
parent cdbb2e96
Pipeline #17821 passed with stage
in 1 minute and 52 seconds
......@@ -6,8 +6,22 @@ The library is a wrapper around [Spring Security](https://spring.io/projects/spr
While still being used, the former v1.4 is discontinued and - being based on OpenSAML 2 ([also discontinued](https://wiki.shibboleth.net/confluence/display/OpenSAML/Home)) - should be replaced with a recent version.
## Dependencies
The library and sample application are deployed to a Maven repository:
## Deployment and distribution
The library and sample application are deployed to a Maven repository at [https://minfba.de.dariah.eu/nexus]. Repository configuration can be included in Maven and Gradle settings and build configurations with the following snippets.
#### 1a) Maven: repository configuration
The Proxy repository _minfba-central_ provides access to releases and snapshots.
```xml
<repository>
<id>minfba-central</id>
<name>minfba-central</name>
<url>https://minfba.de.dariah.eu/nexus/repository/minfba-central/</url>
</repository>
```
The release and snapshot repositories can be used selectively as well.
```xml
<repository>
......@@ -22,9 +36,28 @@ The library and sample application are deployed to a Maven repository:
</snapshotRepository>
```
#### 1b) Gradle: repository configuration
Likewise, repository configuration in Gradle can be based on the central or dedicated snapshot and release repositories as well.
```groovy
repositories {
maven {
url "https://minfba.de.dariah.eu/nexus/repository/minfba-central/"
}
// maven {
// url "https://minfba.de.dariah.eu/nexus/repository/minfba-releases/"
// }
// maven {
// url "https://minfba.de.dariah.eu/nexus/repository/minfba-snapshots/"
// }
}
```
#### 2a) Maven: dependency to dariahsp-core
For the [current snapshot version](https://minfba.de.dariah.eu/nexus/#browse/browse:minfba-central:eu%2Fdariah%2Fde%2Fdariahsp-core) of the library:
#### Maven
```xml
<dependency>
<groupId>eu.dariah.de</groupId>
......@@ -33,7 +66,7 @@ For the [current snapshot version](https://minfba.de.dariah.eu/nexus/#browse/bro
</dependency>
```
#### Gradle
#### 2b) Gradle: dependency to dariahsp-core
```
implementation 'eu.dariah.de:dariahsp-core:2.0.0-SNAPSHOT'
```
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment