From d42078d3dfde87c9b02ed5183811fbfaa35f8468 Mon Sep 17 00:00:00 2001 From: nanne-aben <47976799+nanne-aben@users.noreply.github.com> Date: Wed, 4 Oct 2023 16:59:52 +0200 Subject: [PATCH] Fix README (#195) * update * update * update * update * update --- README.md | 26 +++++++++++++------------- docs/source/README.rst | 6 ++++++ 2 files changed, 19 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index c7071ec..5a8ea3e 100644 --- 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?**
diff --git a/docs/source/README.rst b/docs/source/README.rst index 63e6e13..bc1ad01 100644 --- 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 `_ and `code `_. +* Jupyter / Databricks Notebook demo: `video `_ and `code `_. + FAQ ===