Skip to content

Commit

Permalink
Add documentation badge.
Browse files Browse the repository at this point in the history
  • Loading branch information
Laurent Girod committed May 4, 2020
1 parent 6423149 commit bed0034
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit bed0034

Please sign in to comment.