update README and add url to pyproject.toml

qiskit-community · Jul 31, 2024 · f28b4fd · f28b4fd
1 parent 4915087
commit f28b4fd
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,19 @@
 
 Simulate [Qiskit](https://www.ibm.com/quantum/qiskit) circuits using [quimb](https://quimb.readthedocs.io/en/latest/).
 
+## Installation
+
+```bash
+pip install qiskit-quimb
+```
+
+## Usage
+
+The `qiskit_quimb` module exposes two functions:
+
+- `quimb_circuit`: Converts a Qiskit circuit to a quimb circuit. This is probably the function you want to use.
+- `quimb_gates`: Converts a Qiskit circuit to a list of quimb gates, which is a bit more flexible.
+
 ## Example code
 
 ```python

diff --git a/pyproject.toml b/pyproject.toml
@@ -24,6 +24,9 @@ dependencies = ["qiskit", "quimb"]
 [project.optional-dependencies]
 dev = ["coverage", "mypy", "pytest", "qiskit[visualization]", "ruff"]
 
+[project.urls]
+Homepage = "https://github.com/qiskit-community/qiskit-quimb"
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]