Update README for LandSea.jl

README.md

@@ -1,6 +1,43 @@
-# LandSea
+<p align="center">
+<img alt="LandSea.jl Logo" src=https://raw.githubusercontent.com/GeoRegionsEcosystem/LandSea.jl/main/src/logosmall.png />
+</p>
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://natgeo-wong.github.io/LandSea.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://natgeo-wong.github.io/LandSea.jl/dev/)
-[![Build Status](https://github.com/natgeo-wong/LandSea.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/natgeo-wong/LandSea.jl/actions/workflows/CI.yml?query=branch%3Amain)
-[![Coverage](https://codecov.io/gh/natgeo-wong/LandSea.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/natgeo-wong/LandSea.jl)
+# **<div align="center">LandSea.jl</div>**
+
+<p align="center">
+  <a href="https://www.repostatus.org/#active">
+    <img alt="Repo Status" src="https://www.repostatus.org/badges/latest/active.svg?style=flat-square" />
+  </a>
+  <a href="https://github.com/GeoRegionsEcosystem/LandSea.jl/actions/workflows/ci.yml">
+    <img alt="GitHub Actions" src="https://github.com/GeoRegionsEcosystem/LandSea.jl/actions/workflows/ci.yml/badge.svg?branch=main&style=flat-square">
+  </a>
+  <br>
+  <a href="https://mit-license.org">
+    <img alt="MIT License" src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square">
+  </a>
+	<img alt="MIT License" src="https://img.shields.io/github/v/release/GeoRegionsEcosystem/LandSea.jl.svg?style=flat-square">
+  <a href="https://GeoRegionsEcosystem.github.io/LandSea.jl/stable/">
+    <img alt="Latest Documentation" src="https://img.shields.io/badge/docs-stable-blue.svg?style=flat-square">
+  </a>
+  <a href="https://GeoRegionsEcosystem.github.io/LandSea.jl/dev/">
+    <img alt="Latest Documentation" src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square">
+  </a>
+</p>
+
+**Created By:** Nathanael Wong ([email protected])
+
+## **Introduction**
+
+LandSea.jl is a Julia package that aims to streamline the following process(es):
+* downloading and analysis of various Land-Sea masks for different datasets for different packages
+
+LandSea in and of itself does not download the Land-Sea mask datasets. What it does is provide a unified `struct` type that can be used across different packages and dataset types.
+
+LandSea.jl can be installed via
+```
+] add LandSea
+```
+
+## **Usage**
+
+Please refer to the [documentation](https://georegionsecosystem.github.io/LandSea.jl/dev/) for instructions and examples.