Merge branch 'main' into glw/plot-jra55

CliMA · Nov 13, 2023 · 562c491 · 562c491
2 parents 561dde6 + 0480438
commit 562c491
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,3 +7,17 @@
 [![Build status](https://badge.buildkite.com/3113cca353b83df3b5855d3f0d69827124614aef7017c835d2.svg)](https://buildkite.com/clima/climaocean-ci)
 
 Ocean component for CliMa's Earth system model based on Oceananigans.
+
+## Installation
+
+To install from a Julia REPL:
+
+```julia
+julia> ]
+
+pkg> add https://github.com/CliMA/ClimaOcean.jl.git
+
+pkg> instantiate
+```
+
+You can add `#main` to add the latest from `main` branch or `@vX.X` to install a tagged release.