Skip to content

Commit 3a4bda2

Browse files
committed
Update README: add badges, install from PyPI
1 parent b52b8ab commit 3a4bda2

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# ResINS
2+
3+
[![PyPI](https://img.shields.io/pypi/v/resins)](https://pypi.org/project/resins)
4+
[![Tests](https://github.com/pace-neutrons/resins/actions/workflows/run_tests.yml/badge.svg)](https://github.com/pace-neutrons/resins/actions/workflows/run_tests.yml)
5+
[![License](https://img.shields.io/pypi/l/resins)](https://github.com/pace-neutrons/resins/blob/main/LICENSE)
6+
27
Python library for working with resolution functions of inelastic neutron scattering (INS)
38
instruments. This package exists to centralise all things related to resolution of INS instruments
49
and make it easier to work with. It pools related code from existing projects, namely
@@ -84,17 +89,17 @@ However, the model also provides methods that go lower;
8489

8590
## Installation
8691

87-
This package can be installed using pip, though it is not yet on PyPI, so it has to be installed directly from GitHub:
92+
This package can be installed from PyPI
8893

8994
```
90-
pip install git+https://github.com/pace-neutrons/resins.git
95+
pip install resins
9196
```
9297

9398
or from a local copy:
9499

95100
```
96101
git clone https://github.com/pace-neutrons/resins.git
97-
pip install resins
102+
pip install ./resins
98103
```
99104

100105

0 commit comments

Comments
 (0)