Skip to content

Adding table of contents to README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
legionth wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adding table of contents to README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,23 @@
PHP 8 introduced several changes to how type-loose comparison operators behave. These changes can lead to inconsistencies and unpredictable behavior when running PHP 7 code on PHP 8.
This toolbox helps maintainers of PHP codebases migrate their applications smoothly by identifying usages of type-unsafe operators that would otherwise have changed the behavior of their application.


## Table of Contents

- [Key Features](#key-features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Setting up the Project](#setting-up-the-project)
- [Refactoring](#refactoring)
- [Example Replacement](#example-replacement)
- [Testing Your Code](#testing-your-code)
- [Rolling Back](#rolling-back)
- [Contributing](#contributing)
- [Steps to Contribute](#steps-to-contribute)
- [License](#license)
- [Support & Feedback](#support--feedback)

## Key Features

- **Automatic Replacement of Comparison Operators:** Replace type-loose comparison operators (e.g., `==`, `!=`) with new custom replacement functions (like `c_eq` for `==`, `c_ne` for `!=`).
Expand Down