Update README.md

EHTJulia · Sep 22, 2023 · 7018928 · 7018928
1 parent d1630ac
commit 7018928
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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")
+```