Skip to content

Commit 5036f90

Browse files
committed
Improve readme, add citation block
1 parent 4233cdc commit 5036f90

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

100755100644
Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
# python-psn
22

3-
Pure Python parsing library for PSN V2 - [PosiStageNet](https://posistage.net/)
3+
Pure Python parsing library for PSN V2 - [PosiStageNet](https://posistage.net/),[Official PSN specification](https://github.com/vyv/psn-cpp/blob/master/doc/PosiStageNetprotocol_v2.03_2019_09_09.pdf)
44

5-
[Official PSN specification](https://github.com/vyv/psn-cpp/blob/master/doc/PosiStageNetprotocol_v2.03_2019_09_09.pdf)
5+
This library is used for example by [BlenderDMX](https://blenderdmx.eu)
6+
([BlenderDMX on GitHub](https://github.com/open-stage/blender-dmx)).
67

7-
[Source code](https://github.com/open-stage/python-psn)
8-
9-
[PyPi page](https://pypi.org/project/pypsn/)
8+
[GitHub Page](https://github.com/open-stage/python-psn), [PyPi page](https://pypi.org/project/pypsn/)
109

1110
[![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-
1311
[![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)
12+
![GitHub Tag](https://img.shields.io/github/v/tag/open-stage/python-psn)
1413

1514
## Installation
1615

@@ -48,7 +47,7 @@ receiver.stop() # stop receiving
4847

4948
```
5049

51-
### Senfing PSN data
50+
### Sending PSN data
5251
```python
5352
import pypsn
5453

@@ -117,3 +116,17 @@ mypy pypsn/*py --pretty --no-strict-optional
117116
pytest --mypy -m mypy pypsn/*py
118117
```
119118

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

0 commit comments

Comments
 (0)