Skip to content

Commit

Permalink
Fix README to show graphics on PyPI (#2961)
Browse files Browse the repository at this point in the history
* Fix for PyPI

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Few more tweaks

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Few more tweaks

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Few more tweaks

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Few more tweaks

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Update README.md

* Update README.md

---------

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
  • Loading branch information
stichbury authored Aug 23, 2023
1 parent 7065cac commit 5925b03
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![Kedro Logo Banner - Light](.github/demo-dark.png#gh-dark-mode-only)
![Kedro Logo Banner - Dark](.github/demo-light.png#gh-light-mode-only)
![Kedro Logo Banner - Light](https://raw.githubusercontent.com/kedro-org/kedro/main/.github/demo-dark.png#gh-dark-mode-only)
![Kedro Logo Banner - Dark](https://raw.githubusercontent.com/kedro-org/kedro/main/.github/demo-light.png#gh-light-mode-only)
[![Python version](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue.svg)](https://pypi.org/project/kedro/)
[![PyPI version](https://badge.fury.io/py/kedro.svg)](https://pypi.org/project/kedro/)
[![Conda version](https://img.shields.io/conda/vn/conda-forge/kedro.svg)](https://anaconda.org/conda-forge/kedro)
Expand Down Expand Up @@ -37,9 +37,6 @@ Our [Get Started guide](https://docs.kedro.org/en/stable/get_started/install.htm

## What are the main features of Kedro?

![Kedro-Viz Pipeline Visualisation](https://github.com/kedro-org/kedro-viz/blob/main/.github/img/banner.png)
_A pipeline visualisation generated using [Kedro-Viz](https://github.com/kedro-org/kedro-viz)_

| Feature | What is this? |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Project Template | A standard, modifiable and easy-to-use project template based on [Cookiecutter Data Science](https://github.com/drivendata/cookiecutter-data-science/). |
Expand All @@ -54,7 +51,15 @@ The [Kedro documentation](https://docs.kedro.org/en/stable/) first explains [how

You can then review the [spaceflights tutorial](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) to build a Kedro project for hands-on experience

For new and intermediate Kedro users, there's a comprehensive section on [how to visualise Kedro projects using Kedro-Viz](https://docs.kedro.org/en/stable/visualisation/index.html) and [how to work with Kedro and Jupyter notebooks](https://docs.kedro.org/en/stable/notebooks_and_ipython/index.html). We also recommend the [API reference documentation](/kedro) for additional information.
For new and intermediate Kedro users, there's a comprehensive section on [how to visualise Kedro projects using Kedro-Viz](https://docs.kedro.org/en/stable/visualisation/index.html).


<p align="center">
<img src="https://raw.githubusercontent.com/kedro-org/kedro-viz/main/.github/img/banner.png" alt>
<em>A pipeline visualisation generated using Kedro-Viz</em>
</p>

Additional documentation explains [how to work with Kedro and Jupyter notebooks](https://docs.kedro.org/en/stable/notebooks_and_ipython/index.html), and there are a set of advanced user guides for advanced for key Kedro features. We also recommend the [API reference documentation](/kedro) for further information.


## Why does Kedro exist?
Expand Down

0 comments on commit 5925b03

Please sign in to comment.