Fix README (#195)

* update * update * update * update * update
kaiko-ai · Oct 4, 2023 · d42078d · d42078d
1 parent 91dda8b
commit d42078d
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -39,6 +39,19 @@ The advantages include:
 ## Documentation
 Please see our documentation on [readthedocs](https://typedspark.readthedocs.io/en/latest/index.html).
 
+## Installation
+
+You can install ``typedspark`` from [pypi](https://pypi.org/project/typedspark/) by running:
+
+```bash
+pip install typedspark
+```
+By default, ``typedspark`` does not list ``pyspark`` as a dependency, since many platforms (e.g. Databricks) come with ``pyspark`` preinstalled.  If you want to install ``typedspark`` with ``pyspark``, you can run:
+
+```bash
+pip install "typedspark[pyspark]"
+```
+
 ## Demo videos
 
 ### IDE demo
@@ -53,19 +66,6 @@ https://github.com/kaiko-ai/typedspark/assets/47976799/39e157c3-6db0-436a-9e72-4
 
 You can find the corresponding code [here](docs/videos/notebook.ipynb).
 
-## Installation
-
-You can install ``typedspark`` from [pypi](https://pypi.org/project/typedspark/) by running:
-
-```bash
-pip install typedspark
-```
-By default, ``typedspark`` does not list ``pyspark`` as a dependency, since many platforms (e.g. Databricks) come with ``pyspark`` preinstalled.  If you want to install ``typedspark`` with ``pyspark``, you can run:
-
-```bash
-pip install "typedspark[pyspark]"
-```
-
 ## FAQ
 
 **I found a bug! What should I do?**</br>

diff --git a/docs/source/README.rst b/docs/source/README.rst
@@ -54,6 +54,12 @@ By default, ``typedspark`` does not list ``pyspark`` as a dependency, since many
 
     pip install "typedspark[pyspark]"
 
+Demo videos
+===========
+
+* IDE demo: `video <https://github.com/kaiko-ai/typedspark/assets/47976799/e6f7fa9c-6d14-4f68-baba-fe3c22f75b67>`_ and `code <https://github.com/kaiko-ai/typedspark/blob/main/docs/videos/ide.ipynb>`_.
+* Jupyter / Databricks Notebook demo: `video <https://github.com/kaiko-ai/typedspark/assets/47976799/39e157c3-6db0-436a-9e72-44b2062df808>`_ and `code <https://github.com/kaiko-ai/typedspark/blob/main/docs/videos/notebook.ipynb>`_.
+
 FAQ
 ===