Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
crschnick committed Nov 23, 2024
1 parent 92a8aa9 commit 42adc65
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,27 @@ It also comes with a variety of neat features that will make working with module
You can get the library through [maven central](https://search.maven.org/artifact/io.xpipe/modulefs).
Note that at least Java 17 is required as it is the first LTS release that includes all necessary bug fixes for the internal module file systems.

## Installation

To use ModuleFS with Maven you have to add it as a dependency:

<dependency>
<groupId>io.xpipe</groupId>
<artifactId>modulefs</artifactId>
<version>0.1.6</version>
</dependency>

For gradle, add the following entries to your build.gradle file:

dependencies {
implementation group: 'io.xpipe', name: 'modulefs', version: '0.1.6'
}

Add the library to your project's module-info like this:

requires io.xpipe.modulefs;

Note that ModuleFS requires your project to be modularized.

## Motivation

Expand Down
2 changes: 1 addition & 1 deletion modulefs/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ plugins {
id 'signing'
}

version '0.1.6'
version '0.1.7-SNAPSHOT'
group 'io.xpipe'
archivesBaseName = 'modulefs'

Expand Down

0 comments on commit 42adc65

Please sign in to comment.