From 658303b1a353e68a6d3bdec12a090526e92b99c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elisa=20M=C3=A1rquez=20Zavala?= Date: Tue, 15 Oct 2024 13:56:11 +0200 Subject: [PATCH] Update README.md --- README.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 63a56ef..2552d06 100644 --- a/README.md +++ b/README.md @@ -3,29 +3,35 @@ [![PyPI Version](https://img.shields.io/pypi/v/cutiepynb.svg)](https://pypi.python.org/pypi/cutiepynb) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/cutiepynb.svg)](https://anaconda.org/conda-forge/cutiepynb) ![Run Python Tests](https://github.com/emarquezz/cutiepynb/actions/workflows/python-tests.yml/badge.svg) +![macOS Build Status](https://github.com/emarquezz/cutiepynb/actions/workflows/macos.yml/badge.svg) +![Ubuntu Build Status](https://github.com/emarquezz/cutiepynb/actions/workflows/ubuntu.yml/badge.svg) +![Windows Build Status](https://github.com/emarquezz/cutiepynb/actions/workflows/windows.yml/badge.svg) -**Turn your Jupyter Notebooks into beautiful, colorful cutie ipynb with cutiepynb!** +**Turn your Jupyter Notebooks into beautiful, colorful cutie ipynb with cutiepynb!** Dress them up with vibrant title colors and an auto-generated table of contents. - **License:** [MIT License](LICENSE) - **Documentation:** [cutiepynb Docs](https://emarquezz.github.io/cutiepynb) -## Features +## Features ✨ -- Customizable title colors for notebook headings. -- Automatic table of contents generation. -- Supports dynamic updates to heading styles. -- Works seamlessly with various seaborn color palettes. +- 🎨 **Customizable title colors** for notebook headings. +- 📚 **Automatic table of contents generation**. +- 🔄 **Supports dynamic updates** to heading styles. +- 🌈 **Works seamlessly with various seaborn color palettes**. ## Installation You can install `cutiepynb` via pip: + ```bash pip install cutiepynb +``` ## Examples -To see `cutiepynb` in action, run the following script to process example notebooks: -```bash -python run_examples.py +To see cutiepynb in action, run the following script to process example notebooks: +```bash +python run_examples.py +```