Skip to content

Add Introduction to README #354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hf-kklein merged 3 commits into from
Jan 31, 2022
Merged

Add Introduction to README #354

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5670882
Add Introduction to README
hf-kklein Jan 23, 2022
168511a
Merge branch 'master' into hf-kklein-patch-5
hf-kklein Jan 31, 2022
2fba420
Update README.rst
hf-kklein Jan 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ BO4E
|PyPI pyversions|_



.. |PyPi| image:: https://img.shields.io/pypi/v/bo4e.svg
.. _PyPi: https://img.shields.io/pypi/v/bo4e

Expand All @@ -21,25 +20,31 @@ BO4E
.. _`PyPI pyversions`: https://pypi.python.org/pypi/bo4e/


🇩🇪 Dies ist eine BO4E Referenz-Implementierung in Python.
Gleichzeitig ist dieses Repository der Ort, um Fragen und Erweiterungen des BO4E-Standards zu diskutieren.

🇬🇧 This is a Python library that implements Business Objects for Energy `BO4E <https://www.bo4e.de/>`_.
It requires Python >=3.8.

Dokumentation / Fragen und Anregungen zum BO4E Datenmodell
==========================================================
Eine Dokumentation des Datenmodells und JSON Schemata zur Erzeugung von Beispieldaten finden sich auf `read the docs <https://bo4e-python.readthedocs.io/en/master/api/bo4e.html>`_.

Bei Fragen oder Anregungen, bitte `einfach ein Issue in diesem Repo aufmachen <https://github.com/Hochfrequenz/BO4E-python/issues/new?assignees=&labels=BO4E+Enhancement+Proposal&template=funktionale-anforderung-an-den-bo4e-standard.md&title=Ein+aussagekr%C3%A4ftiger+Titel%3A+Hunde-+und+Katzentarife+k%C3%B6nnen+nicht+abgebildet+werden>`_.

Python Library that Implements `BO4E <https://www.bo4e.de/dokumentation>`_.
Requires Python >=3.8.
Code Beiträge
=============
Änderungsvorschläge (sowohl an das Datenmodell als auch an die Implementierung in Python) können direkt als Code in Form von Pull Requests eingereicht werden.
Details dazu finden sich im `Contribution Guide`_.

Other Noteworthy BO4E Implementations
=====================================
Andere nennenswerte BO4E Implementierungen
==========================================

* `C#/.NET`_
* `Golang`_
* `Kotlin`_
* `TypeScript`_

Code Beiträge
============
Änderungsvorschläge können direkt als Code in Form von Pull Requests eingereicht werden.
Details dazu finden sich im `Contribution Guide`_.


Versioning
==========
| Short background information about versioning of python packages.
Expand Down