Skip to content

Commit

Permalink
README.rst: update for PyPI
Browse files Browse the repository at this point in the history
  • Loading branch information
miri64 committed Feb 10, 2023
1 parent 6a15ec0 commit 9ab308b
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,24 @@ pylibschc: A python wrapper for libSCHC
.. image:: https://codecov.io/gh/anr-bmbf-pivot/pylibschc/branch/main/graph/badge.svg?token=KPOQ0ERP9H
:target: https://codecov.io/gh/anr-bmbf-pivot/pylibschc

.. image:: https://img.shields.io/pypi/status/pylibschc
:alt: PyPI - Status
:target: https://pypi.org/project/pylibschc/

.. image:: https://img.shields.io/pypi/pyversions/pylibschc
:alt: PyPI - Python Version
:target: https://pypi.org/project/pylibschc/

This provides a pythonic wrapper for `libSCHC`_.

Installation
============

You can use ``pip`` to install the package once you cloned this repo:
You can use ``pip`` to install the package once from `PyPI`_:

.. code:: bash
git clone https://github.com/anr-bmbf-pivot/pylibschc.git
cd pylibschc
pip install .
pip install pylibschc
Usage
=====
Expand Down Expand Up @@ -203,6 +209,7 @@ that libSCHC is dual licensed for non-open source use. For more, have a look at
libSCHC.

.. _`libSCHC`: https://github.com/imec-idlab/libschc
.. _`PyPI`: https://pypi.org/project/pylibschc
.. _`pydantic`: https://pydantic.dev
.. _`scapy`: https://scapy.net/
.. |pylibschc.rules| replace:: ``pylibschc.rules``
Expand Down

0 comments on commit 9ab308b

Please sign in to comment.