diff --git a/README.md b/README.md index b15c38c..f3fbc56 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,14 @@ # flip Field Level Inference Package: a python package to infer cosmological parameters from density and velocity field +[![Documentation Status](https://readthedocs.org/projects/flip/badge/?version=latest)](https://flip.readthedocs.io/en/latest/?badge=latest) + +## Quick install +```python +git clone https://github.com/corentinravoux/flip.git +cd flip +pip install . +``` + +## Need help? Documentation available on [ReadTheDoc](https://flip.readthedocs.io/)