Merge pull request #4 from SpeedyWeather/mk/readme

Update README.md

Author: milankl

README.md

@@ -4,24 +4,45 @@ Repository for the implementation of the stochastic stirring forcing and jet dra
 [Barnes and Hartmann, 2011](https://journals.ametsoc.org/view/journals/atsc/68/12/jas-d-11-039.1.xml?tab_body=fulltext-display#bib14)
 and [Vallis et al. 2004](https://journals.ametsoc.org/view/journals/atsc/61/3/1520-0469_2004_061_0264_amasdm_2.0.co_2.xml).
 
-See also https://github.com/SpeedyWeather/SpeedyWeather.jl/issues/394
+## Background
 
-To be used like
+See 
+- https://github.com/SpeedyWeather/SpeedyWeather.jl/issues/394
+- Issue https://github.com/SpeedyWeather/StochasticStir.jl/issues/3
+
+## Installation
+
+Via Julia's package manager (opened with `]`)
+
+```julia
+julia>] add https://github.com/SpeedyWeather/StochasticStir.jl
+```
+or via `using Pkg; Pkg.add("https://github.com/SpeedyWeather/StochasticStir.jl")`.
+This package is not registered in Julia's general registry, so you have to specify
+the whole URL as above. Requires SpeedyWeather.jl v0.8 or higher.
+
+## Usage
 
 ```julia
 using SpeedyWeather
 using StochasticStir
 
 # model components
 spectral_grid = SpectralGrid(trunc=42,nlev=1)   
-forcing = StochasticStirring(spectral_grid,latitude=45)
+forcing = StochasticStirring(spectral_grid,latitude=45,strength=7e-11)
 drag = JetDrag(spectral,time_scale=Day(6))
 initial_conditions = StartFromRest()
 
 # construct the model and initialize
 model = BarotropicModel(;spectral_grid,initial_conditions,forcing,drag)
 simulation = initialize!(model)
 
-# now run
-run!(simulation)
+# now run and store output
+run!(simulation,period=Day(100),output=true)
 ```
+
+## Gallery
+
+A visualisation of the above simulation 
+
+https://github.com/SpeedyWeather/StochasticStir.jl/assets/25530332/3924a9fd-8515-4628-8128-f555e6054616