From 4bb79781debd3cfa2ed2b14954671b6394b020ea Mon Sep 17 00:00:00 2001
From: Rima <153289003+casks-mutters@users.noreply.github.com>
Date: Thu, 11 Dec 2025 03:03:29 -0500
Subject: [PATCH] Docs: add README to describe project usage and functionality

## Summary

The project currently does not have a README file. Adding one will provide clarity on what the script does, how to use it, and any prerequisites or configuration.

## Proposed Changes

- Create a `README.md` file with:
  - Project overview: what the script does (produces a signed JSON attestation for a storage slot across two blocks).
  - Installation instructions: required dependencies (e.g. `web3`, `eth-account`).
  - Usage example with arguments.
  - Explanation of the optional signing functionality and environment variable setup (e.g. `PRIVATE_KEY`).

## Motivation

- Provides clarity for new users and contributors.
- Improves project documentation and ease of use.
---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 43b341a..120c790 100644
--- a/README.md
+++ b/README.md
@@ -68,3 +68,11 @@ This makes outputs reproducible across nodes given identical inputs.
 - **Invalid address**: Double-check 0x prefix and length; use checksummed addresses.
 - **Rate limited (HTTP 429)**: Increase `--interval`, change provider, or add a paid key.
 
+# zk-gas-soundness Attestation Tool
+
+This tool generates a signed JSON attestation for an Ethereum contract storage slot, comparing values at two blocks. It includes the contract address, slot number, and block numbers, and can sign the attestation with a private key.
+
+## Usage
+
+```sh
+python attestation_tool.py --address 0xYourContractAddress --slot 123 --block_a 1000 --block_b 2000 --rpc https://mainnet.infura.io/v3/YOUR_API_KEY