From bed00340639b60d8b7329c4eb877fac98baabb78 Mon Sep 17 00:00:00 2001 From: Laurent Girod Date: Mon, 4 May 2020 11:33:45 +0200 Subject: [PATCH] Add documentation badge. --- README.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index c42783a..53bf568 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,16 @@ petrelic ======== .. image:: https://travis-ci.org/spring-epfl/petrelic.svg?branch=master - :target: https://travis-ci.org/spring-epfl/petrelic + :target: https://travis-ci.org/spring-epfl/petrelic + :alt: Build status + +.. image:: https://readthedocs.org/projects/petrelic/badge/?version=latest + :target: https://petrelic.readthedocs.io/en/latest/?badge=latest + :alt: Documentation Status .. image:: https://codecov.io/gh/spring-epfl/petrelic/branch/master/graph/badge.svg - :target: https://codecov.io/gh/spring-epfl/petrelic + :target: https://codecov.io/gh/spring-epfl/petrelic + :alt: Test coverage ``petrelic`` is a Python wrapper around `RELIC`_. It provides a simple python interface to the BLS-381 pairing and RELIC's big number class. Our goals is to make it easy to prototype new cryptographic applications in Python using RELIC as the backend. In the future we aim to support a few other pairing curves as well.