Skip to content

Commit

Permalink
(docs) usage and badges in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alexey-pelykh committed Jun 20, 2024
1 parent ae21976 commit 9110d65
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
# PCRE4J: PCRE for Java

![GitHub License](https://img.shields.io/github/license/alexey-pelykh/pcre4j)
![GitHub branch check runs](https://img.shields.io/github/check-runs/alexey-pelykh/pcre4j/main)
![Maven Central Version](https://img.shields.io/maven-central/v/org.pcre4j/lib)

The PCRE4J project's goal is to bring the power of the [PCRE](https://www.pcre.org) library to Java.

This project is brought to you by [Alexey Pelykh](https://github.com/alexey-pelykh) with a great gratitude to the PCRE
library author [Philip Hazel](https://github.com/PhilipHazel) and its contributors.

## Usage

To use the PCRE4J library in your project, add the following dependency to your `pom.xml` file:

```xml
<dependency>
<groupId>org.pcre4j</groupId>
<artifactId>lib</artifactId>
<version>0.0.0</version>
</dependency>
<dependency>
<groupId>org.pcre4j</groupId>
<!-- TODO: Select one of the following artifacts corresponding to the backend you want to use -->
<artifactId>jna</artifactId>
<!-- <artifactId>ffm</artifactId> -->
<version>0.0.0</version>
</dependency>
```

Then, you can use the PCRE4J library in your Java code as follows:

```java
import org.pcre4j.Pcre2Code;
import org.pcre4j.Pcre2CompileOption;
Expand Down

0 comments on commit 9110d65

Please sign in to comment.