Skip to content

Commit 59ce4c8

Browse files
committed
Improved docs
1 parent a21e9fc commit 59ce4c8

2 files changed

Lines changed: 28 additions & 22 deletions

File tree

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -138,20 +138,23 @@ More examples can be found in the
138138

139139
## Interactive App
140140

141-
Use our app to visualize and explore your data without writing code. You can
142-
use it directly on
143-
[Our Demo App](https://tda-mapper-app.up.railway.app/),
144-
or locally on your machine. The first time you run the app locally, you may
145-
need to install the required dependencies by running
141+
Use our app to interactively visualize and explore your data without writing
142+
code. You can try it right away using
143+
[our live demo](https://tda-mapper-app.up.railway.app/),
144+
or run it locally on your machine.
146145

147-
```bash
148-
pip install tda-mapper[app]
149-
```
146+
To run it locally:
150147

151-
then run the app locally with
148+
1. Install the app and its dependencies:
152149

153-
```bash
154-
tda-mapper-app
155-
```
150+
```bash
151+
pip install tda-mapper[app]
152+
```
153+
154+
2. Launch the app:
155+
156+
```bash
157+
tda-mapper-app
158+
```
156159

157160
![tda-mapper-app](https://github.com/lucasimi/tda-mapper-python/raw/main/resources/tda-mapper-app.png)

docs/source/quickstart.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -92,21 +92,24 @@ More examples can be found in the
9292
Interactive App
9393
---------------
9494

95-
Use our app to visualize and explore your data without writing code. You can
96-
use it directly on
97-
`Our Demo App <https://tda-mapper-app.up.railway.app/>`__,
98-
or locally on your machine. The first time you run the app locally, you may
99-
need to install the required dependencies by running
95+
Use our app to interactively visualize and explore your data without writing
96+
code. You can try it right away using
97+
`our live demo <https://tda-mapper-app.up.railway.app/>`__,
98+
or run it locally on your machine.
10099

101-
.. code:: bash
100+
To run it locally:
102101

103-
pip install tda-mapper[app]
102+
1. Install the app and its dependencies:
104103

105-
then run the app locally with
104+
.. code:: bash
106105
107-
.. code:: bash
106+
pip install tda-mapper[app]
107+
108+
2. Launch the app:
109+
110+
.. code:: bash
108111
109-
tda-mapper-app
112+
tda-mapper-app
110113
111114
|Interactive App|
112115

0 commit comments

Comments
 (0)