From 127356bc89d1c608adde17404467e6f71c181d44 Mon Sep 17 00:00:00 2001
From: samuelfatzinger <105595582+samuelfatzinger@users.noreply.github.com>
Date: Thu, 26 Mar 2026 13:23:05 -0500
Subject: [PATCH] Update README.md

Improve README structure, input format, and documentation clarity
---
 README.md | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 34063c5..71f3c8a 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,33 @@
 [![Coverage Status](https://coveralls.io/repos/github/OpenGreekAndLatin/ILA_python/badge.svg?branch=master)](https://coveralls.io/github/OpenGreekAndLatin/ILA_python?branch=master)
 [![Documentation Status](https://readthedocs.org/projects/ila-python/badge/?version=latest)](http://ila-python.readthedocs.io/en/latest/?badge=latest)
 
-# Intra Language Alignment tool
+# Intra Language Alignment Tool
 
-The tool allows automatic alignment between multiple texts in the same language, for the detection of textual variants and minor instances of re-use.
+## Overview
+
+This tool allows automatic alignment between multiple texts in the same language for the detection of textual variants and minor instances of reuse.
+
+## Installation
+
+Install the package locally:  
+`pip install .`
+
+Or for development:  
+`pip install -e .`
+
+## Usage
+
+Import the `iAlignment` package in Python:  
+`import iAlignment`
+
+The package provides tools for aligning and comparing texts within the same language.
+
+## Examples
+
+The `examples/` directory contains sample scripts, input data, and HTML output files demonstrating how to use the tool.
+
+These examples provide a starting point for running alignments and viewing the resulting output.
+
+## Requirements
+
+- Python 3.4+