summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Willhaus <mail@janwillhaus.de>2019-05-18 17:59:57 +0200
committerJan Willhaus <mail@janwillhaus.de>2019-05-18 19:10:15 +0200
commite5e16728bba97f0b84830765b8fb3340059f305e (patch)
treefe84c0c87fe50f728751fb18b75cc496e9c5ca5a
parent02354094d45398da7babe0f555e1c360c58fd467 (diff)
downloadwarlock-e5e16728bba97f0b84830765b8fb3340059f305e.tar.gz
Update readme header
-rw-r--r--README.md25
1 files changed, 22 insertions, 3 deletions
diff --git a/README.md b/README.md
index ec3e1c1..4edb851 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,21 @@
-# Warlock
+# Warlock — self-validating Python objects using JSON schema
-[![Build Status](https://travis-ci.org/bcwaldon/warlock.svg?branch=master)](https://travis-ci.org/bcwaldon/warlock)
+[![PyPI](https://img.shields.io/pypi/v/warlock.svg)][warlock]
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/warlock.svg)][warlock]
+[![PyPI - Downloads](https://img.shields.io/pypi/dw/warlock.svg)][pypistats]
-Build self-validating python objects using JSON schemas.
+[![Build Status](https://travis-ci.org/bcwaldon/warlock.svg?branch=master)][ci-builds]
+[![Coverage Status](https://coveralls.io/repos/github/bcwaldon/warlock/badge.svg?branch=master)][coveralls]
+
+## Installation
+
+Warlock is [available on PyPI][warlock]:
+
+```shell
+pip install warlock
+```
+
+## Usage
1) Create your schema
@@ -56,3 +69,9 @@ Build self-validating python objects using JSON schemas.
>>> sweden.patch
'[{"path": "/population", "value": 9453000, "op": "add"}]'
```
+
+[warlock]: https://pypi.org/project/warlock/
+[pip]: https://pip.pypa.io/en/stable/
+[ci-builds]: https://travis-ci.org/bcwaldon/warlock
+[coveralls]: https://coveralls.io/github/bcwaldon/warlock?branch=master
+[pypistats]: https://pypistats.org/packages/warlock