Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rmorshea committed May 26, 2023
1 parent 506def4 commit 7822667
Showing 1 changed file with 1 addition and 28 deletions.
29 changes: 1 addition & 28 deletions README.md
Expand Up @@ -18,22 +18,6 @@ To install use `pip`:
pip install reactpy_jupyter
```

Then, before anything else, do one of the following:

1. At the top of your notebook run

```python
import reactpy_jupyter
```

2. Register `reactpy_jupyter` as a permanant IPython extension in [your config file](https://ipython.readthedocs.io/en/stable/config/intro.html#introduction-to-ipython-configuration):

```python
c.InteractiveShellApp.extensions = [
'reactpy_jupyter'
]
```

## Usage

Once you're done [getting started](#getting-started), you can author and display ReactPy
Expand All @@ -58,7 +42,7 @@ the `reactpy_juptyer.widgetize` function. This is useful if you wish to use Reac
with other Jupyter Widgets as in the following example:

```python
ClickCountWidget = reactpy_jupyter.widgetize(ClickCount)
ClickCountWidget = reactpy_jupyter.to_widget(ClickCount)
ipywidgets.Box(
[
ClickCountWidget(),
Expand All @@ -67,17 +51,6 @@ ipywidgets.Box(
)
```

Alternatively just wrap an `reactpy` element instance in an `reactpy_jupyter.LayoutWidget`:

```python
ipywidgets.Box(
[
reactpy_jupyter.LayoutWidget(ClickCount()),
reactpy_jupyter.LayoutWidget(ClickCount()),
]
)
```

For a more detailed introduction check out this live demo here:

<a href="https://mybinder.org/v2/gh/reactive-python/reactpy-jupyter/main?filepath=notebooks%2Fintroduction.ipynb">
Expand Down

0 comments on commit 7822667

Please sign in to comment.