Merge pull request #21 from CliMA/ne/readme

Update Readme

README.md

@@ -1,2 +1,36 @@
-# CalibrateAtmos.jl
-Calibration pipeline for ClimaAtmos.jl
+<!-- Title -->
+<h1 align="center">
+  CalibrateAtmos.jl
+</h1>
+
+<!-- description -->
+<p align="center">
+  <strong>The calibration pipeline for ClimaAtmos.jl</strong>
+</p>
+
+[![docsbuild][docs-bld-img]][docs-bld-url]
+[![dev][docs-dev-img]][docs-dev-url]
+[![ghaci][gha-ci-img]][gha-ci-url]
+[![codecov][codecov-img]][codecov-url]
+
+[docs-bld-img]: https://github.com/CliMA/CalibrateAtmos.jl/workflows/Documentation/badge.svg
+[docs-bld-url]: https://github.com/CliMA/CalibrateAtmos.jl/actions?query=workflow%3ADocumentation
+
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: https://CliMA.github.io/CalibrateAtmos.jl/dev/
+
+[gha-ci-img]: https://github.com/CliMA/CalibrateAtmos.jl/actions/workflows/ci.yml/badge.svg
+[gha-ci-url]: https://github.com/CliMA/CalibrateAtmos.jl/actions/workflows/ci.yml
+
+[codecov-img]: https://codecov.io/gh/CliMA/CalibrateAtmos.jl/branch/main/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/CliMA/CalibrateAtmos.jl
+
+The recommended Julia version is: Stable release v1.9.3
+This pipeline currently runs on the Resnick High Performance Computing Center.
+We strive to support flexible and clearly documented calibration experiments.
+
+## Contributing
+
+If you're interested in contributing to the development of CalibrateAtmos we want your help no matter how big or small a contribution you make! It's always great to have new people look at the code with fresh eyes: you will see errors that other developers have missed.
+
+Let us know by [opening an issue](https://github.com/CliMA/CalibrateAtmos.jl/issues/new) if you'd like to work on a new feature.