Skip to content

Commit fdbea9d

Browse files
committed
Update README
1 parent 3c24ea6 commit fdbea9d

File tree

1 file changed

+29
-22
lines changed

1 file changed

+29
-22
lines changed

README.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,43 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
1+
# 4byte.sourcify.dev
22

3-
## Getting Started
3+
Ethereum function and event signature database interface for Sourcify verified contracts.
44

5-
First, run the development server:
5+
## Overview
6+
7+
A Next.js web interface for searching and looking up Ethereum function selectors and event signatures from the [OpenChain API](https://openchain.xyz). The database is built from Sourcify verified smart contracts.
8+
9+
## Features
10+
11+
- **Text search**: Use wildcards (`*`, `?`) to find function/event signatures
12+
- **Hash lookup**: Search by 4-byte function selectors or 32-byte event hashes
13+
- **Auto-detection**: Automatically determines search type based on input format
14+
- **Copy to clipboard**: Easy copying of signatures and hashes
15+
- **Statistics**: Live count of functions and events in the database
16+
17+
## Development
618

719
```bash
20+
npm install
821
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
1522
```
1623

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18-
19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
24+
Open [http://localhost:3000](http://localhost:3000) to view the application.
2025

21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
26+
## Static Export
2227

23-
## Learn More
28+
Build static files for deployment:
2429

25-
To learn more about Next.js, take a look at the following resources:
26-
27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
30+
```bash
31+
npm run build
32+
```
2933

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
34+
Generated files will be in the `out` directory.
3135

32-
## Deploy on Vercel
36+
## Environment Variables
3337

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
38+
Copy `.env.example` to `.env.local` and configure:
3539

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
40+
```
41+
NEXT_PUBLIC_OPENCHAIN_API_URL=https://api.openchain.xyz
42+
NEXT_PUBLIC_UMAMI_WEBSITE_ID=your-website-id
43+
```

0 commit comments

Comments
 (0)