Skip to content

Commit

Permalink
docs(readme): update readme with current requirements (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
fernandonogueira authored Mar 2, 2024
1 parent 2d8b274 commit 8b9aed7
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,54 @@ when your application uses a multi-instance architecture and you must upgrade or
Feel free to contribute and ask changes to this project.
Pull Requests are also welcome and will be approved quickly.

Ox is used since 2014 in production but it wasn't open source before.
Ox is used since 2014 in production environments.

## Motivation

When you have to manage a lot of MongoDB databases it may consume a lot of time when you need to keep your indexes and documents in the right version.

This project simplifies that.

## Requirements

Compatible with Java 17+ and MongoDB 2.6 to 7.x.

## Installation

### Maven

```xml
<dependency>
<groupId>com.github.fernandonogueira</groupId>
<artifactId>ox</artifactId>
<version>x.y.z</version>
</dependency>

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

### Gradle

```groovy
dependencies {
implementation 'com.github.fernandonogueira:Ox:x.y.z'
}
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
mavenCentral()
maven { url 'https://jitpack.io' }
}
}
```


## Usage

#### Creating migrations...
Expand Down

0 comments on commit 8b9aed7

Please sign in to comment.