Skip to content

Commit

Permalink
docs: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ZeroEkkusu committed Dec 4, 2023
1 parent ab8efb8 commit a332f67
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Storage Layout Checker

Storage Layout Checker is made to simplify contract upgrades. It compares the storage layout between two suite versions and provides insights into the changes.

> [!NOTE]
> V1 identifies all differences but doesn't escalate and de-escalate findings.
Storage Layout Checker is made to simplify contract upgrades. It compares the storage layout between two suite versions and provides insights into the changes.

## Upcoming Features

### V2
Expand All @@ -14,11 +14,11 @@ Storage Layout Checker is made to simplify contract upgrades. It compares the st

### V3

- **Support for Special Fields**: Adds support for `__gap` and `__legacy` naming.
- **Support for Special Variables**: Adds support for `__gap` and `__legacy` variables.

### CI

- **CI Integration**: Runs on code push and PR.
- **CI Integration**: Runs on push and pull requests.

## Requirements

Expand All @@ -40,15 +40,15 @@ bash lib/storage-layout-checker/run.sh <COMMIT_OR_TAG>

Contracts with identified differences will be listed as `OLD` and `NEW` table files. To examine a finding, open the two files side by side.

Additionally, `removed.txt` file will be created, with the names of removed contracts.
Additionally, `removed.txt` file will be created, with the names of deleted contracts.

## Legend

| Emoji | Meaning |
| ----- | ------------ |
| ❗️ | Questionable |
| 🗑️ | Removed |
|| New |
| Emoji | Meaning |
| ----- | ----------- |
| ❗️ | Problematic |
| 🗑️ | Deleted |
|| New |

---

Expand Down

0 comments on commit a332f67

Please sign in to comment.