updated docs

README.md

@@ -1,7 +1,50 @@
 # MQSS Qiskit Adapter
 
-[![Documentation](https://img.shields.io/badge/Documentation-Read%20the%20Docs-blue)](https://munich-quantum-software-stack.github.io/MQSS-Qiskit-Adapter/)\
-![PyPI - Version](https://img.shields.io/pypi/v/mqss-qiskit)\
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mqss-qiskit)\
-![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/:user/:repo/:workflow)\
-![GitHub License](https://img.shields.io/github/license/Munich-Quantum-Software-Stack/MQSS-Qiskit-Adapter)
+[![Documentation](https://img.shields.io/badge/Documentation-Read%20the%20Docs-blue)](https://munich-quantum-software-stack.github.io/MQSS-Interfaces/qiskit/index.html)
+![PyPI - Version](https://img.shields.io/pypi/v/mqss-qiskit)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mqss-qiskit)
+
+This repository implements a Qiskit Adapter, which is able to send quantum jobs to LRZ's
+infrastructure.
+
+## Installation
+
+To install the package, simply run
+
+```bash
+pip install mqss-qiskit
+```
+
+## Usage
+
+MQSS Qiskit Adapter has support for most of the basic features that a Qiskit provider implement. For
+all available features, see the detailed
+[documentation](https://munich-quantum-software-stack.github.io/MQSS-Interfaces/qiskit/index.html).
+
+```python
+from mqss.qiskit_adapter import MQSSQiskitAdapter
+from qiskit.circuit import QuantumCircuit
+
+#Create a quantum circuit
+qc = QuantumCircuit(2)
+qc.h(0)
+qc.cx(0, 1)
+qc.measure_all()
+
+# Get the desired backend
+mqss_adapter = MQSSQiskitAdapter(token="<TOKEN>")
+[backend] = mqss_adapter.backends(name="<BACKEND_NAME>")
+
+# Submit the jobs
+job = backend.run(qc, shots=100)
+
+# Get the results
+print(job.result().get_counts())
+
+```
+
+To get a token and see available backends visit [MQP](https://portal.quantum.lrz.de).
+
+## Contributing
+
+Feel free to open issues or submit pull requests to improve this project!

docs/user_guide/development_guide.md

@@ -18,7 +18,7 @@ Qiskit. The main components of the project are:
 
 Before you start developing, ensure you have the following installed:
 
-- Python 3.8 to 3.11
+- Python 3.9 to 3.13
 - [`uv`](https://docs.astral.sh/uv/) package manager for python
 
 ## Setting Up the Development Environment
@@ -44,9 +44,9 @@ To run the tests, use `pytest`:
 uv run pytest
 ```
 
-## Publishing Documentation on GitHub Pages
+## Building Documentation
 
-To publish the documentation on GitHub Pages, follow these steps:
+To build the documentation, follow these steps:
 
 **Install MkDocs and the Material theme:**
 
@@ -60,20 +60,11 @@ uv sync
 uv run mkdocs build
 ```
 
-**View documentation locally**
+**Local deployment**
 
 Run the following and browse the documentation locally at:
 [http://localhost:8000](http://localhost:8000)
 
 ```sh
 uv run mkdocs serve
 ```
-
-**Deploy the documentation to GitHub Pages:**
-
-```sh
-uv run mkdocs gh-deploy --remote-name git@github.com:Munich-Quantum-Software-Stack/MQSS-Qiskit-Adapter.git --remote-branch gh-pages
-```
-
-This will create a new branch named `gh-pages` in your repository and deploy the documentation to
-GitHub Pages.