diff --git a/vizro-core/README.md b/vizro-core/README.md index e7cf7a833..69bdd55d0 100644 --- a/vizro-core/README.md +++ b/vizro-core/README.md @@ -1,41 +1,27 @@ -

+

+ +
-

Vizro logo -

-
- -
- -Vizro is a low-code toolkit for building high-quality data visualization apps - -
-
+#### Vizro is a low-code toolkit for building high-quality data visualization apps [![Python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue.svg)](https://pypi.org/project/vizro/) [![PyPI version](https://badge.fury.io/py/vizro.svg)](https://badge.fury.io/py/vizro) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mckinsey/vizro/blob/main/LICENSE.md) [![Documentation](https://readthedocs.org/projects/vizro/badge/?version=stable)](https://vizro.readthedocs.io/) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7858/badge)](https://www.bestpractices.dev/projects/7858) -
- -
- -Documentation | Get Started | Vizro examples gallery - -
+[Documentation](https://vizro.readthedocs.io/en/stable/) | [Get Started](https://vizro.readthedocs.io/en/stable/pages/tutorials/first_dashboard/) | [Vizro examples gallery](http://vizro.mckinsey.com/) ---- +
-

-

- -

+
+
-

+
+ ## What is Vizro? @@ -45,22 +31,22 @@ Use it to build beautiful and powerful data visualization apps quickly and easil Then customize and deploy your app to production at scale. -

- - -Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality multi-page prototypes. - -

- +
+ +Use a few lines of simple low-code configuration, with in-built visual design best practices, to assemble high-quality +multi-page prototypes. +

The benefits of the Vizro toolkit include: -

+

-

+
+
+ +Visit our ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features. -Visit ["How-to guides"](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/) for a more detailed explanation of Vizro features. ## Why use Vizro? @@ -98,79 +84,47 @@ Use Vizro when you need to combine the speed and ease of low-code Python tools, ## How to use Vizro? -
- -
-

Vizro framework

+### [Vizro framework](https://vizro.readthedocs.io/en/stable/) -

Low-code framework for building dashboards. +**Low-code framework for building dashboards** The Vizro framework underpins the entire Vizro toolkit. It is a Python package (called `vizro`). -Visit the documentation for more details. +Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more details. -

-
- - -
- -
-
-
- -
-

Visual vocabulary

+### [Visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) -

- Chart examples. +**Chart examples** The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code to create these charts with Plotly or embed them into a Vizro dashboard. -Visit the visual vocabulary to search for charts or get inspiration. +Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to search for charts or get inspiration. -

-
-
+ -
-
-
-
-

Vizro examples gallery

+### [Vizro examples gallery](https://vizro.mckinsey.com/) -

- Dashboard examples. +**Dashboard examples** The dashboard examples gallery enables you to explore Vizro in action by viewing interactive example apps. You can copy the code to use as a template or starter for your next dashboard. -Visit the dashboard examples gallery to see the dashboards in action. +Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the dashboards in action. -

-
- -
+ -
-
-
- -
-

Vizro-AI

+### [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai) -

- LLM generated charts and dashboards. +**LLM generated charts and dashboards** Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorporate LLMs. Use it to build interactive Vizro charts and dashboards, by simply describing what you need in plain English or other languages. -Visit the Vizro-AI documentation for more details. +Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/) for more details. + + -

-
-
## Installation and first steps