Skip to content

Commit

Permalink
update reademe with badge and instructions for pypi
Browse files Browse the repository at this point in the history
solves #15
  • Loading branch information
kjmeagher authored Jul 26, 2023
1 parent 79a8123 commit 906b578
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
..
.. SPDX-License-Identifier: BSD-2-Clause
|pre-commit.ci| |tests| |docs| |codecov| |LICENSE|
|pre-commit.ci| |tests| |docs| |codecov| |LICENSE| |pypi|

.. |tests| image:: https://github.com/icecube/simweights/actions/workflows/tests.yml/badge.svg?branch=main
:target: https://github.com/icecube/simweights/actions/workflows/tests.yml
Expand All @@ -15,6 +15,9 @@
.. |pre-commit.ci| image:: https://results.pre-commit.ci/badge/github/icecube/simweights/main.svg
:target: https://results.pre-commit.ci/latest/github/icecube/simweights/main
:alt: pre-commit.ci status
.. |pypi| image:: https://badge.fury.io/py/simweights.svg
:target: https://pypi.org/project/simweights/
:alt: PyPi

.. badge-break
Expand Down Expand Up @@ -50,7 +53,13 @@ Prerequisites
Installation
============

To install with pip:
To install from pypi run:

.. code-block:: shell-session
pip install simweights
Alternatively, if you need to install unreleased code from main you can run:

.. code-block:: shell-session
Expand Down

0 comments on commit 906b578

Please sign in to comment.