chore: clean up notebook and README

ericrallen · Sep 22, 2023 · 41a6319 · 41a6319
1 parent df5f36d
commit 41a6319
Show file tree

Hide file tree

Showing 4 changed files with 447 additions and 285 deletions.
diff --git a/README.md b/README.md
@@ -2,22 +2,26 @@
 
 In this interactive workshop powered by a Jupyter Notebook, we'll explore the basics of traditional Sentiment Analysis and how we can expand our sentiment analysis capabilities with ChatGPT and some clever prompting strategies.
 
-## Interactive Notebook
+## Web-based Notebook
 
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ericrallen/sentiment-analysis-notebook/main)
 
-In addition to being available on Binder, this [workshop notebook](https://ericrallen.github.io/sentiment-analysis-notebook/) is automatically deployed to GitHub Pages.
+In addition to being available on Binder, this [workshop notebook](https://ericrallen.github.io/sentiment-analysis-notebook/) is automatically deployed to GitHub Pages via [`jupyter-book`](https://jupyterbook.org/intro.html).
 
-**Note**: Unfortunately, the `ipywidgets` library used to create interactive demonstrations in the notebook does not seem to cooperate with GitHub Pages. This is my first Jupyter Notebook, so it's likely that I misconfigured something.
+**Note**: Unfortunately, the `ipywidgets` library used to create interactive demonstrations in the notebook does not seem to cooperate with GitHub Pages or the interactive cells provided by [Thebe](https://jupyterbook.org/en/stable/interactive/thebe.html?highlight=thebe). This is my first Jupyter Notebook, so it's likely that I misconfigured something.
 
-## Pre-requisites
+**Note**: If you are running this notebook locally, it will look for the `OPENAI_API_KEY` environment variable, but you can also manually enter your OpenAI API key into the notebook.
+
+## Getting Started
+
+To run and interact with this notebook locally, follow the instructions below.
+
+### Pre-requisites
 
 1. Python `>=3.11`
 2. [OpenAI API Key](https://platform.openai.com/account/api-keys)
 
-**Note**: If you are running this notebook locally, it will look for the `OPENAI_API_KEY` environment variable, but you can also manually enter your OpenAI API key into the notebook.
-
-## Getting Started
+### Installation
 
 1. Clone this repository
 
@@ -43,7 +47,3 @@ In addition to being available on Binder, this [workshop notebook](https://ericr
    ```shell
    jupyter notebook
    ```
-
-## Resources
-
-_Coming Soon_