Skip to content

Commit 248c8fd

Browse files
committed
Introduce a few badges
1 parent c96e802 commit 248c8fd

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
11

22
# python-libzim
33

4-
> The Python bindings for [`libzim`](https://github.com/openzim/libzim).
5-
6-
```bash
7-
# Install from PyPI: https://pypi.org/project/libzim/
8-
pip3 install libzim
9-
```
4+
The Python bindings for [`libzim`](https://github.com/openzim/libzim).
105

116
This library allows you to interact with `.zim` files via Python.
127

138
It just provides a shallow Python interface on top of the `libzim` C++ library (maintained by [OpenZIM](https://github.com/openzim)).
149

1510
It is primarily used by [`sotoki`](https://github.com/openzim/sotoki).
1611

12+
[![](https://img.shields.io/pypi/v/libzim.svg)](https://pypi.python.org/pypi/libzim)
13+
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
14+
15+
## Installation
16+
17+
```bash
18+
# Install from PyPI: https://pypi.org/project/libzim/
19+
pip3 install libzim
20+
```
21+
1722
## Quickstart
1823

1924
### Reader API
@@ -196,3 +201,8 @@ python setup.py install
196201
- https://github.com/pypa/manylinux
197202
- https://github.com/RalfG/python-wheels-manylinux-build/blob/master/full_workflow_example.yml
198203
- https://packaging.python.org/guides/packaging-binary-extensions/#publishing-binary-extensions
204+
205+
## License
206+
207+
[GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see
208+
[LICENSE](LICENSE) for more details.

0 commit comments

Comments
 (0)