Skip to content

Commit

Permalink
docs: add ToC to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pavdmyt committed Oct 19, 2024
1 parent 78754d3 commit 858b836
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,26 @@ $ python script_that_uses_yaspin.py > script.log
$ python script_that_uses_yaspin.py | grep ERROR
```

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Basic Example](#basic-example)
- [Spinners from cli-spinners](#run-any-spinner-from-cli-spinners)
- [Colors](#any-colour-you-like-)
- [Advanced colors usage](#advanced-colors-usage)
- [Building custom spinners](#run-any-spinner-you-want)
- [Changing spinner properties on the fly](#change-spinner-properties-on-the-fly)
- [Timer](#spinner-with-timer)
- [Custom Ellipsis](#custom-ellipsis)
- [Dynamic text](#dynamic-text)
- [Writing messages](#writing-messages)
- [Integration with other libraries](#integration-with-other-libraries)
- [Handling POSIX signals](#handling-posix-signals)
- [Development](#development)
- [Contributing](#contributing)
- [License](#license)

## Installation

From [PyPI](https://pypi.org/) using `pip` package manager:
Expand Down

0 comments on commit 858b836

Please sign in to comment.