Skip to content

Commit 8fde64f

Browse files
committed
Improve readme, add citation block
1 parent 4233cdc commit 8fde64f

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

100755100644
Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ Pure Python parsing library for PSN V2 - [PosiStageNet](https://posistage.net/)
44

55
[Official PSN specification](https://github.com/vyv/psn-cpp/blob/master/doc/PosiStageNetprotocol_v2.03_2019_09_09.pdf)
66

7-
[Source code](https://github.com/open-stage/python-psn)
7+
This library is used for example by [BlenderDMX](https://blenderdmx.eu)
8+
([BlenderDMX on GitHub](https://github.com/open-stage/blender-dmx)).
89

9-
[PyPi page](https://pypi.org/project/pypsn/)
10+
[GitHub Page](https://github.com/open-stage/python-psn), [PyPi page](https://pypi.org/project/pypsn/)
1011

1112
[![Pytest](https://github.com/open-stage/python-psn/actions/workflows/run-tests.yaml/badge.svg)](https://github.com/open-stage/python-psn/actions/workflows/run-tests.yaml)
12-
1313
[![Check links in markdown](https://github.com/open-stage/python-psn/actions/workflows/check-links.yaml/badge.svg)](https://github.com/open-stage/python-psn/actions/workflows/check-links.yaml)
14+
![GitHub Tag](https://img.shields.io/github/v/tag/open-stage/python-psn)
1415

1516
## Installation
1617

@@ -48,7 +49,7 @@ receiver.stop() # stop receiving
4849

4950
```
5051

51-
### Senfing PSN data
52+
### Sending PSN data
5253
```python
5354
import pypsn
5455

@@ -117,3 +118,17 @@ mypy pypsn/*py --pretty --no-strict-optional
117118
pytest --mypy -m mypy pypsn/*py
118119
```
119120

121+
## Citation
122+
123+
If you use this library in your research, publication, or software project,
124+
please cite it as follows:
125+
126+
```bibtex
127+
@software{pypsn2025,
128+
title = {pyPSN: Python Library for PosiStageNet},
129+
author = {{OpenStage}},
130+
year = {2025},
131+
version = {0.2.3},
132+
url = {https://github.com/open-stage/python-psn}
133+
}
134+
```

0 commit comments

Comments
 (0)