diff --git a/README.md b/README.md index f68c9e8..5b86dfb 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,12 @@ [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://EHTJulia.github.io/ScatteringOptics.jl/dev/) [![Build Status](https://github.com/EHTJulia/ScatteringOptics.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/EHTJulia/ScatteringOptics.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Coverage](https://codecov.io/gh/EHTJulia/ScatteringOptics.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/EHTJulia/ScatteringOptics.jl) + +This Julia Package provides a framework to simulate Interstellar-Medium-generated stochastic scattering on EHT VLBI models. + +## Installation +The package is being registered to the Julia standard repository as of [TBD]. Once registered, it will be installable by +```julia +using Pkg +Pkg.add("StationaryRandomFields") +```