updated README

README.md

@@ -1,40 +1,45 @@
----
-title: Everycure Ner Pdf
-emoji: 🐢
-colorFrom: indigo
-colorTo: purple
-sdk: docker
-pinned: false
----
+# Everycure NER PDF
 
-## local dev
+Extract named entities from PDF documents.
 
-install dependencies:
+## Quick Start
+
+### Installation
 
 ```sh
 uv venv
 UV_PYTHON=3.12 uv pip install -r pyproject.toml
 ```
 
+### Running Locally
+
+Start the server:
+
 ```sh
 uv run src/everycure/app.py 
 ```
 
-if your pdfs are in a folder called `pdfs/` run:
+### Usage
 
-```
-curl -v -X POST -F "file=@pdfs/MECFS systematic review.pdf" http://localhost:8000/api/v1/extract
+Process a PDF file (assuming your PDFs are in a `pdfs/` folder):
+
+```sh
+curl -X POST -F "file=@pdfs/MECFS systematic review.pdf" http://localhost:8000/api/v1/extract
 ```
 
-to test remote (unfortunately quite slow):
+### Remote API
 
-```
+The service is also available remotely:
+
+```sh
 curl -X POST -F "file=@pdfs/MECFS systematic review.pdf" https://lucharo-everycure-ner-pdf.hf.space/api/v1/extract 
 ```
 
-check API docs at <https://lucharo-everycure-ner-pdf.hf.space/docs>
+API documentation: <https://lucharo-everycure-ner-pdf.hf.space/docs>
+
+## Development
 
-### run tests
+Run tests:
 
 ```sh
 uv pip install -e .[dev]