Skip to content

Commit

Permalink
chore(docs): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lmichaelis committed Mar 3, 2024
1 parent 0c20411 commit 09999ec
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# _ZenKit4Py_

A Python-library wrapping the [ZenKit](https://github.com/GothicKit/ZenKit) library for parsing game assets of
[PiranhaBytes'](https://www.piranha-bytes.com/) early 2000's games [Gothic](https://en.wikipedia.org/wiki/Gothic_(video_game))
and [Gothic II](https://en.wikipedia.org/wiki/Gothic_II).

![PyPI - License](https://img.shields.io/pypi/l/zenkit?style=flat&label=License)
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FGothicKit%2FZenKit4Py%2Fmain%2Fpyproject.toml&style=flat&label=Python)
[![PyPI - Version](https://img.shields.io/pypi/v/zenkit?label=PyPI)](https://pypi.org/project/zenkit/)

A Python-library wrapping the [ZenKit](https://github.com/GothicKit/ZenKit) library for parsing game assets of [PiranhaBytes'](https://www.piranha-bytes.com/) early 2000's games [Gothic](https://en.wikipedia.org/wiki/Gothic_(video_game)) and [Gothic II](https://en.wikipedia.org/wiki/Gothic_II).

> [!TIP]
> See the [documentation](https://zk.gothickit.dev/library/quickstart/#python) for setup instructions.

0 comments on commit 09999ec

Please sign in to comment.