From 03611ab248d5d803253fa14e03667438a24be0c9 Mon Sep 17 00:00:00 2001
From: carlosuc3m <49989524+carlosuc3m@users.noreply.github.com>
Date: Mon, 9 Dec 2024 15:39:55 +0100
Subject: [PATCH] Update README.md

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index ff698f7..f24a7c6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
 [![Build Status](https://github.com/segment-anything-models-java/SAMJ/actions/workflows/build.yml/badge.svg)](https://github.com/segment-anything-models-java/SAMJ/actions/workflows/build.yml)
 
 
+
+# SAMJ: Segment-Anything-Model for Java software
+SAMJ is a Java based package that brings the [Segment-Anything-Model (SAM)](https://github.com/facebookresearch/segment-anything) to Java software. Thanks to [Appose](https://github.com/apposed/appose) SAMJ enables the installation and use of different variants of SAM.
+
+SAMJ provides a simple API for installation and inference of SAM models.
+
+# Quickstart
+The inly thing you need to incorporate SAMJ to your software is to add the dependency with Maven to the `pom.xml` file:
+
+```
+<dependency>
+	<groupId>ai.nets</groupId>
+	<artifactId>samj</artifactId>
+	<version>0.0.3-SNAPSHOT</version>
+</dependency>
+```
+