Skip to content

Add information about Maven Central to README #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 21, 2025
Merged

Add information about Maven Central to README #66

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 37 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,53 +104,62 @@ non-vectorized implementation. For an example usage, see
examples/vector/Example.java. The feature requires JDK 19+ and is currently for
advanced users.

JavaFastPFOR as a dependency (JitPack)
JavaFastPFOR as a dependency
------------------------

JavaFastPFOR is available both on Maven Central and JitPack, so you can easily
include it in your project using either source.

We have a demo project using JavaFastPFOR as a dependency (both Maven and Gradle). See...

https://github.com/fast-pack/JavaFastPFORDemo

1. **Maven**
### Maven Central

You can add JavaFastPFOR directly from Maven Central — no extra repository configuration needed:

Using this code in your own project is easy with maven, just add
the following code in your pom.xml file:
**Maven**

```xml
<dependency>
<groupId>com.github.fast-pack</groupId>
<artifactId>JavaFastPFor</artifactId>
<version>JavaFastPFOR-0.3.2</version>
</dependency>
<dependency>
<groupId>me.lemire.integercompression</groupId>
<artifactId>JavaFastPFOR</artifactId>
<version>0.3.8</version>
</dependency>
```

as well as jitpack as a repository...
**Gradle (Groovy)**

```xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
```groovy
dependencies {
implementation 'me.lemire.integercompression:JavaFastPFOR:0.3.8'
}
```

Naturally, you should replace "version" by the version
you desire.
### JitPack

If you prefer or need to use JitPack, you can include the dependency like this:

2. **Gradle (groovy)**
**Maven**

```xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>

<dependency>
<groupId>com.github.fast-pack</groupId>
<artifactId>JavaFastPFOR</artifactId>
<version>JavaFastPFOR-0.3.8</version>
</dependency>
```

Then all you need is to edit your `build.gradle` file like so:

**Gradle (groovy)**

```groovy
plugins {
id 'java'
}


repositories {
mavenCentral()
maven {
Expand All @@ -159,11 +168,10 @@ repositories {
}

dependencies {
implementation 'com.github.fast-pack:JavaFastPFor:JavaFastPFOR-0.3.2'
implementation 'com.github.fast-pack:JavaFastPFOR:JavaFastPFOR-0.3.8'
}
```


Naturally, you should replace "version" by the version
you desire.

Expand Down