diff --git a/README.md b/README.md index 9971fa7..375ce67 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,30 @@ # cutiepynb +[![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) -[![image](https://img.shields.io/pypi/v/cutiepynb.svg)](https://pypi.python.org/pypi/cutiepynb) -[![image](https://img.shields.io/conda/vn/conda-forge/cutiepynb.svg)](https://anaconda.org/conda-forge/cutiepynb) +**Turn your Jupyter Notebooks into beautiful, colorful creations with cutiepynb!** Dress them up with vibrant title colors and an auto-generated table of contents. - -**Dress up your Jupyter Notebooks and make them a cutie pie!** -Custom your title colors and create an automatic table of contents. - - -- Free software: MIT License -- Documentation: https://emarquezz.github.io/cutiepynb - +- **License:** [MIT License](LICENSE) +- **Documentation:** [cutiepynb Docs](https://emarquezz.github.io/cutiepynb) ## Features -- TODO +- 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 \ No newline at end of file +python run_examples.py + +