From 11fd99d331ae95cab58f9c492a63612dc70c7bfa Mon Sep 17 00:00:00 2001
From: Panos Vagenas <35837085+vagenas@users.noreply.github.com>
Date: Tue, 23 Jul 2024 13:56:34 +0200
Subject: [PATCH] docs: revamp installation instructions

Signed-off-by: Panos Vagenas <35837085+vagenas@users.noreply.github.com>
---
 README.md | 25 ++++++++++++-------------
 1 file changed, 12 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 790084d..edfc9e0 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+# Docling Core
+
 [![PyPI version](https://img.shields.io/pypi/v/docling-core)](https://pypi.org/project/docling-core/)
 ![Python](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11-blue)
 [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
@@ -6,28 +8,25 @@
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
 [![Pydantic v2](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://pydantic.dev)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
-[![License MIT](https://img.shields.io/github/license/ds4sd/deepsearch-toolkit)](https://opensource.org/licenses/MIT)
-
-# Docling Core
+[![License MIT](https://img.shields.io/github/license/ds4sd/docling-core)](https://opensource.org/licenses/MIT)
 
 Docling Core is a library that defines the data types in [Docling](https://ds4sd.github.io), leveraging pydantic models.
 
 ## Installation
 
-Using [Poetry](https://python-poetry.org), create and activate a virtual environment.
-
-```
-poetry shell
+To use Docling Core, simply install `docling-core` from your package manager, e.g. pip:
+```bash
+pip install docling-core
 ```
 
-Install the defined dependencies of the project.
+### Development setup
 
-```
+To develop for Docling Core, you need Python 3.9 / 3.10 / 3.11 and Poetry. You can then install from your local clone's root dir:
+```bash
 poetry install
 ```
 
-Test the installation running the pytest suite.
-
+To run the pytest suite, execute:
 ```
 poetry run pytest test
 ```
@@ -77,7 +76,7 @@ Please read [Contributing to Docling Core](./CONTRIBUTING.md) for details.
 
 ## References
 
-If you use `Docling Core` in your projects, please consider citing the following:
+If you use Docling Core in your projects, please consider citing the following:
 
 ```bib
 @software{Docling,
@@ -92,5 +91,5 @@ year = {2024}
 
 ## License
 
-The `Docling Core` codebase is under MIT license.
+The Docling Core codebase is under MIT license.
 For individual model usage, please refer to the model licenses found in the original packages.