Updating the readme

Signed-off-by: Peter Staar <[email protected]>

Author: PeterStaar-IBM

README.md

@@ -1,2 +1,88 @@
 # docling-agent
-Agent that read, write and edit documents.
+
+<p align="center">
+  <a href="https://trendshift.io/repositories/12132" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12132" alt="DS4SD%2Fdocling | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+</p>
+
+[![PyPI version](https://img.shields.io/pypi/v/docling-agent)](https://pypi.org/project/docling-agent/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/docling-agent)](https://pypi.org/project/docling-agent/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![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/docling-agent-project/docling-agent)](https://opensource.org/licenses/MIT)
+[![PyPI Downloads](https://static.pepy.tech/badge/docling-agent/month)](https://pepy.tech/projects/docling-agent)
+[![LF AI & Data](https://img.shields.io/badge/LF%20AI%20%26%20Data-003778?logo=linuxfoundation&logoColor=fff&color=0094ff&labelColor=003778)](https://lfaidata.foundation/projects/)
+
+Docling-agent simplifies agentic operation on documents, such as writing, editing, summarizing, etc.
+
+> [!NOTE]
+> **This package is still immature and work-in-progress. We are happy to get comments, suggestions, code contributions, etc!**
+
+## Features
+
+## Installation
+
+**Coming soon**
+
+## Getting started
+
+**Coming soon**
+
+## Documentation
+
+**Coming soon**
+
+## Examples
+
+Go hands-on with our [examples](https://docling-project.github.io/docling/examples/),
+demonstrating how to address different application use cases with Docling.
+
+## Integrations
+
+To further accelerate your AI application development, check out Docling's native
+[integrations](https://docling-project.github.io/docling/integrations/) with popular frameworks
+and tools.
+
+## Get help and support
+
+Please feel free to connect with us using the [discussion section](https://github.com/docling-project/docling/discussions).
+
+## Technical report
+
+For more details on Docling's inner workings, check out the [Docling Technical Report](https://arxiv.org/abs/2408.09869).
+
+## Contributing
+
+Please read [Contributing to Docling](https://github.com/docling-project/docling/blob/main/CONTRIBUTING.md) for details.
+
+## References
+
+If you use Docling or Docling-agent in your projects, please consider citing the following:
+
+```bib
+@techreport{Docling,
+  author = {Deep Search Team},
+  month = {8},
+  title = {Docling Technical Report},
+  url = {https://arxiv.org/abs/2408.09869},
+  eprint = {2408.09869},
+  doi = {10.48550/arXiv.2408.09869},
+  version = {1.0.0},
+  year = {2024}
+}
+```
+
+## License
+
+The Docling codebase is under MIT license.
+For individual model usage, please refer to the model licenses found in the original packages.
+
+## LF AI & Data
+
+Docling is hosted as a project in the [LF AI & Data Foundation](https://lfaidata.foundation/projects/).
+
+### IBM ❤️ Open Source AI
+
+The project was started by the AI for knowledge team at IBM Research Zurich.
+