Merge pull request #33 from ahuang11/update_logo

Update logo
ahuang11 · Apr 6, 2024 · 65f95f5 · 65f95f5
2 parents a2c9568 + 1ec5a7c
commit 65f95f5
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 3 deletions.
diff --git a/docs/assets/logo.png b/docs/assets/logo.png
diff --git a/docs/assets/logo_bw.png b/docs/assets/logo_bw.png
diff --git a/docs/supported_formats.md b/docs/supported_formats.md
@@ -78,6 +78,12 @@ stream(df, uri="gapminder.mp4", groupby="Country", title="{Year}")
     pip install polars pyarrow hvplot selenium webdriver-manager
     ```
 
+    You must also have `firefox` or `chromedriver` installed on your system.
+
+    ```bash
+    conda install -c conda-forge firefox
+    ```
+
 ```python
 from streamjoy import stream
 import polars as pl
@@ -90,7 +96,7 @@ stream(df, uri="gapminder.mp4", groupby="Country", title="{Year}")
 ```
 
 <video controls="true" allowfullscreen="true">
-<source src="https://github.com/ahuang11/streamjoy/assets/15331990/fb07014c-8c63-46da-9ca0-1592e4649ccd" type="video/mp4">
+<source src="https://github.com/ahuang11/streamjoy/assets/15331990/75531331-3974-46b8-8399-6dd14ad31f5c" type="video/mp4">
 </video>
 
 ## 🗄️ XArray Dataset or DataArray
@@ -149,6 +155,12 @@ stream(ds, uri="air.mp4", cmap="RdBu_r")
     pip install pooch netcdf4 hvplot xarray
     ```
 
+    You must also have `firefox` or `chromedriver` installed on your system.
+
+    ```bash
+    conda install -c conda-forge firefox
+    ```
+
 ```python
 import xarray as xr
 import hvplot.xarray

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,8 +8,7 @@ theme:
     name: material
     features:
         - content.code.copy
-    icon:
-        logo: material/library
+    logo: assets/logo.png
     palette:
         # Palette toggle for automatic mode
         - media: "(prefers-color-scheme)"