Merge pull request #127 from legend-exp/readme

update README.md and CITATION file

Author: gipert

.github/release.yml

@@ -0,0 +1,5 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+      - pre-commit-ci

CITATION.cff

@@ -0,0 +1,27 @@
+cff-version: 1.2.0
+title: legend-pygeom-l200
+doi: FILLME
+date-released: 2025-08-08
+message: "If you use this software, please cite it as below."
+authors:
+  - family-names: Pertoldi
+    given-names: Luigi
+    orcid: https://orcid.org/0000-0002-0467-2571
+  - family-names: Huber
+    given-names: Manuel
+    orcid: https://orcid.org/0009-0000-5212-2999
+  - family-names: Neuberger
+    given-names: Moritz
+    orcid: https://orcid.org/0009-0001-8471-9076
+  - family-names: Esch
+    given-names: Eric
+    orcid: https://orcid.org/0009-0000-4920-9313
+  - family-names: Dixon
+    given-names: Toby
+    orcid: https://orcid.org/0000-0001-8787-6336
+  - family-names: Lay
+    given-names: Niko Nanda Putra Nila
+    orcid: https://orcid.org/0009-0008-2446-4287
+  - family-names: Grünauer
+    given-names: Gina
+    orcid: https://orcid.org/0000-0002-6966-293X

README.md

@@ -1,29 +1,21 @@
 # legend-pygeom-l200
 
+[![PyPI](https://img.shields.io/pypi/v/legend-pygeom-l200?logo=pypi)](https://pypi.org/project/legend-pygeom-l200/)
+![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/legend-exp/legend-pygeom-l200?logo=git)
+[![GitHub Workflow Status](https://img.shields.io/github/checks-status/legend-exp/legend-pygeom-l200/main?label=main%20branch&logo=github)](https://github.com/legend-exp/legend-pygeom-l200/actions)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Codecov](https://img.shields.io/codecov/c/github/legend-exp/legend-pygeom-l200?logo=codecov)](https://app.codecov.io/gh/legend-exp/legend-pygeom-l200)
+![GitHub issues](https://img.shields.io/github/issues/legend-exp/legend-pygeom-l200?logo=github)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/legend-exp/legend-pygeom-l200?logo=github)
+![License](https://img.shields.io/github/license/legend-exp/legend-pygeom-l200)
+[![Read the Docs](https://img.shields.io/readthedocs/legend-pygeom-l200?logo=readthedocs)](https://legend-pygeom-l200.readthedocs.io)
 
-> [!WARNING]
->
-> This is an early version of the LEGEND-200 geometry implemented with the
-> python-based simulation stack. It is not a drop-in replacement for MaGe, and
-> still under heavy development!
-
-## Installation and usage
-
-This package requires a working setup of
-[`legend-metadata`](https://github.com/legend-exp/legend-metadata) before usage.
-
-Following a git checkout, the package and its other python dependencies can be
-installed with:
+This package implements the `legend-pygeom-l200` CLI utility to interact with
+the LEGEND-200 geometry.
 
-```
-pip install -e .
-```
-
-If you do not intend to edit the python code in this geometry package, you can
-omit the `-e` option.
-
-After installation, the CLI utility `legend-pygeom-l200` is provided on your
-PATH. This CLI utility is the primary way to interact with this package. For
-now, you can find usage docs by running `legend-pygeom-l200 -h`.
+> [!NOTE]
+>
+> For full functionality, this package requires a working setup of
+> [`legend-metadata`](https://github.com/legend-exp/legend-metadata) before
+> usage.