Merge pull request #156 from jupytercalpoly/waidhoferj/update-readme

Updated readme

Author: jahn96

README.md

@@ -1,13 +1,21 @@
+# Jupyter Bifrost
 
-# jupyter_bifrost
+![Github Actions Status](https://github.com/jupytercalpoly/Jupyter-Bifrost/workflows/Build/badge.svg) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupytercalpoly/Jupyter-Bifrost.git/main?urlpath=lab%2Ftree%2Fexamples%2Fintroduction.ipynb) [![npm version](https://badge.fury.io/js/jupyter_bifrost.svg)](https://badge.fury.io/js/jupyter_bifrost) [![PyPI version](https://badge.fury.io/py/jupyter-bifrost.svg)](https://badge.fury.io/py/jupyter-bifrost) [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) 
 
-[![Build Status](https://travis-ci.org//jupyter_bifrost.svg?branch=master)](https://travis-ci.org//jupyter_bifrost)
-[![codecov](https://codecov.io/gh//jupyter_bifrost/branch/master/graph/badge.svg)](https://codecov.io/gh//jupyter_bifrost)
+![Jupyter Bifrost Workflow](docs/resources/ChartSelection.gif)
+A Jupyter Widget for Interactive Data Visualization. Bifrost provides useful chart recommendations and easy integration with Pandas DataFrames. It also provides a variety of analysis tools:
 
+- Chart history log for keeping track of your data analysis.
+- Targeted graph suggestions to drive further data exploration.
+- Interactive filters for quantitative and categorical fields.
+- Aggregations and binning for axis encodings.
+- An expressive Python API
 
-A Jupyter Widget for Interactive Data Visualization
+The extension allows data scientists to build familiarity with a dataset without sacrificing the reproducibility of code. Changes made in the Bifrost GUI are automatically translated into Pandas Queries, allowing developers to jump back into scripting whenever it is most convenient.
 
-## Installation
+## Getting Started
+
+### Installation
 
 You can install using `pip`:
 
@@ -17,19 +25,48 @@ pip install jupyter_bifrost
 
 If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
 the nbextension:
+
 ```bash
 jupyter nbextension enable --py [--sys-prefix|--user|--system] jupyter_bifrost
 ```
 
+### Using the Extension
+
+Jupyter Bifrost is intended to be used in Jupyter Notebooks in JupyterLab. Start by importing the package:
+
+```python
+from jupyter_bifrost import Chart
+```
+
+Then instantiate the chart object with a dataset:
+
+```python
+chart = Chart("<my-dataset>.csv")
+#or
+df = pd.DataFrame()
+chart = Chart(df)
+```
+
+Finally, plot the dataset to open up the Bifrost GUI:
+
+```python
+res = chart.plot()
+# the `res` DataFrame will always stay up to date with the filters and aggregations applied in the GUI
+```
+
+For additional help with the extension, take a look at the wiki, or the help menu located in the menu bar of the Bifrost GUI.
+
 ## Development Installation
 
 Create a dev environment:
+
 ```bash
 conda create -n jupyter_bifrost-dev -c conda-forge nodejs yarn python jupyterlab
 conda activate jupyter_bifrost-dev
 ```
 
 Install the python. This will also build the TS package.
+
 ```bash
 pip install -e ".[test, examples]"
 ```
@@ -55,18 +92,21 @@ you might also need another flag instead of `--sys-prefix`, but we won't cover t
 of those flags here.
 
 ### How to see your changes
+
 #### Typescript:
+
 If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different
 terminals to watch for changes in the extension's source and automatically rebuild the widget.
 
 ```bash
 # Watch the source directory in one terminal, automatically rebuilding when needed
-yarn run watch
+jlpm watch
 # Run JupyterLab in another terminal
 jupyter lab
 ```
 
 After a change wait for the build to finish and then refresh your browser and the changes should take effect.
 
 #### Python:
+
 If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.