From e220bb5b91e8143558d5aef54854bcabe39548f2 Mon Sep 17 00:00:00 2001
From: Mathew Biddle <8480023+MathewBiddle@users.noreply.github.com>
Date: Fri, 7 Jun 2024 14:08:34 -0400
Subject: [PATCH] Update README.md (#83)

* Update README.md

@ocefpaf mind taking a look?

It's confusing that the git repo is `ioos_metrics` but conda is `ioos-metrics`. Is it too late to adjust that?

* Update README.md

Co-authored-by: Filipe <ocefpaf@gmail.com>

---------

Co-authored-by: Filipe <ocefpaf@gmail.com>
---
 README.md | 32 ++++++++++++++++++++++++++++----
 1 file changed, 28 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 8e5d1c3..54108ee 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,35 @@
-# ioos_by_the_numbers
-Working on creating metrics for the [IOOS by the numbers](https://ioos.noaa.gov/about/ioos-by-the-numbers/)
+# ioos-metrics
 
-Requirements:
+A library to compute and compile metrics about the U.S. Integrated Ocean Observing System (U.S. IOOS®). U.S. IOOS® is a vital tool for tracking, predicting, managing, and adapting to changes in our ocean, coastal and Great Lakes environment.  
 
+Creating metrics for the [IOOS by the numbers](https://ioos.noaa.gov/about/ioos-by-the-numbers/).
+
+"IOOS by the Numbers" is was developed as a graphical representation of IOOS  -- a system of includes our partnerships, research and observing components, and data management capabilities. 
+This figure is an annually updated collection of numbers that show the breadth of the IOOS Program as it is growing and evolving.  
+These data were obtained from multiple sources in July 2022. The original source for each value is identified below. 
+Links to each federal partner or regional association are provided. 
+
+## Installation instructions:
+
+### conda
+```
+conda install ioos-metrics
+```
+
+### pip
+```
+pip install ioos-metrics
+```
+
+## Usage
+
+See <https://github.com/ioos/ioos_metrics/tree/main/notebooks>
 
 ## Website
-Leveraged existing resources from https://github.com/noaa-fisheries-integrated-toolbox/toolbox_web_templating.
+
+url: <https://ioos.github.io/ioos_metrics/>
+
+Leveraged existing resources from <https://github.com/noaa-fisheries-integrated-toolbox/toolbox_web_templating>.
 
 The webpages are built from the `website/` directory.