Added installing process to the documentation
All checks were successful
LambdaTonic / build (push) Successful in 22s

This commit is contained in:
Marco Cetica 2024-09-20 11:27:17 +02:00
parent d05b4c98b1
commit b718c474e1
Signed by: marco
GPG Key ID: 45060A949E90D0FD
2 changed files with 69 additions and 3 deletions

View File

@ -49,6 +49,23 @@ instance of the `Either<L, R>` type, while in any other case, we return a new `R
`Either<L, R>` type. In the caller method(i.e., the `main`) we can then execute a custom statement using
Java's builtin pattern matching.
## Installation
**λTonic** is available on [Maven Central](https://central.sonatype.com/artifact/io.github.ceticamarco/LambdaTonic),
you can install it either by using Maven:
```xml
<dependency>
<groupId>io.github.ceticamarco</groupId>
<artifactId>LambdaTonic</artifactId>
<version>0.0.1</version>
</dependency>
```
or by using Gradle:
```kotlin
implementation 'io.github.ceticamarco:LambdaTonic:0.0.1'
```
## API Usage
The `Either<L, R>` data type supports a broad spectrum of features, below there is a list of all supported
functionalities.

55
pom.xml
View File

@ -4,9 +4,34 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.ceticamarco</groupId>
<groupId>io.github.ceticamarco</groupId>
<artifactId>LambdaTonic</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>
<version>0.0.1</version>
<developers>
<developer>
<id>ceticamarco</id>
<name>Marco Cetica</name>
<email>email@marcocetica.com</email>
</developer>
</developers>
<licenses>
<license>
<name>MIT License</name>
<url>https://opensource.org/licenses/MIT</url>
</license>
</licenses>
<url>https://github.com/ceticamarco/LambdaTonic</url>
<description>λTonic is functional library designed for modern Java</description>
<scm>
<connection>scm:git:https://github.com/ceticamarco/LambdaTonic.git</connection>
<developerConnection>scm:git:https://github.com/ceticamarco/LambdaTonic.git</developerConnection>
<url>https://github.com/ceticamarco/LambdaTonic</url>
</scm>
<properties>
<maven.compiler.source>22</maven.compiler.source>
@ -21,5 +46,29 @@
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.sonatype.central</groupId>
<artifactId>central-publishing-maven-plugin</artifactId>
<version>0.5.0</version>
<extensions>true</extensions>
<configuration>
<publishingServerId>central</publishingServerId>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<executions>
<execution>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>