From 8b9aed74663eef8504aa9c3a745c283451773825 Mon Sep 17 00:00:00 2001
From: Fernando Nogueira <fernandonogueira@users.noreply.github.com>
Date: Sat, 2 Mar 2024 20:34:42 -0300
Subject: [PATCH] docs(readme): update readme with current requirements (#19)

---
 README.md | 42 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 97e7132..9ef0663 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ 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
 
@@ -22,6 +22,46 @@ When you have to manage a lot of MongoDB databases it may consume a lot of time
 
 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...