Chore: update README (#28)

* update readme

* .

* .

Author: kevinddchen

README.md

@@ -4,24 +4,24 @@
 
 ## Manifesto
 
- -  The [Nearshore Wave Prediction System (NWPS) model](https://polar.ncep.noaa.gov/nwps/nwpsloop.php?site=MTR&loop=sigwaveheight&cg=3)
-    has high-resolution data and is quite accurate because it uses a sophisticated nearshore wave model.
+**The goal of this project is to combine the accuracy of NWPS with the user interface of Windy.**
+
+ -  The [Nearshore Wave Prediction System (NWPS)](https://polar.ncep.noaa.gov/nwps/nwpsloop.php?site=MTR&loop=sigwaveheight&cg=3)
+    has high-resolution data and is quite accurate because it uses a sophisticated forecasting model.
     However, I don't like the user interface; you have to click through individual frames and it is difficult to get numerical values.
  -  [Windy](https://www.windy.com/36.616/-121.889/gfsWaves/waves?gfs,36.515,-121.898,11) has a great user interface that also displays wind, tides, etc.
     However, the data doesn't feel very accurate since forecasts don't make much sense between dive sites; why is a 6 ft swell at Breakwater no big deal, but a 6 ft swell at Monastery un-divable?!
 
-**The goal of this project is to combine the accuracy of NWPS with the user interface of Windy.**
+## Data
 
-## Summary
+ -  All wave and tide forecast data comes from [NWPS](https://nomads.ncep.noaa.gov/pub/data/nccf/com/nwps/prod/).
+    We make a very similar map showing the wave height in color and wave direction with arrows.
+    We also plot the wave height over time for two dive sites, [Breakwater (San Carlos beach)](https://maps.app.goo.gl/wHzyiZY1mi4THkto8) and [Monastery beach](https://maps.app.goo.gl/nZdXUZvYriEUVF8z9).
+    This is more similar to Windy's user interface, and is useful for tracking how conditions for a particular site develop over time.
 
-The wave and swell forecast data for [NWPS](https://polar.ncep.noaa.gov/nwps/) is obtained from https://nomads.ncep.noaa.gov/.
-The map visuals were kept largely intact, with the major modifications being zooming into the Monterey peninsula, and adding a slider to scrub through time.
-A graph was added to plot the wave height over time for two dive sites, [Breakwater (San Carlos beach)](https://maps.app.goo.gl/wHzyiZY1mi4THkto8) and [Monastery beach](https://maps.app.goo.gl/nZdXUZvYriEUVF8z9).
-Similar to Windy's user interface, this is useful for tracking how conditions for a particular site develop over time.
+     -  The website updates daily when data from new NWPS runs are available.
 
-The website updates twice a day, when data for new NWPS runs are available.
-
-We use [basemap](https://matplotlib.org/basemap/stable/) to render the coastline map.
+ -  We use [basemap](https://matplotlib.org/basemap/stable/) to render the coastline map.
 
 ## Local Development
 
@@ -30,12 +30,22 @@ This is a Python project, and the easiest way to get started is with [uv](https:
 ```
 uv venv
 uv sync
+source .venv/bin/activate
 ```
 
 To generate the webpage,
 
 ```
-uv run -m wavey
+python -m wavey
 ```
 
 This will create a directory "_site/" which contains the webpage.
+
+We use `mypy` to perform static type checking and `ruff` to perform linting and formatting.
+
+```
+mypy .
+
+ruff check .
+ruff format --check .
+```