Skip to content

Commit c724f59

Browse files
leovctmds1
andauthored
doc: update README and CONTRIBUTING docs (#11)
* doc: update `README` and `CONTRIBUTING` docs * doc: update README --------- Co-authored-by: Matt Solomon <[email protected]>
1 parent 5b5d1fe commit c724f59

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
This repo uses Next.js, Tailwind CSS, TypeScript, pnpm, and viem. To get started:
3+
This repo uses [Next.js](https://github.com/vercel/next.js/), [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss), [TypeScript](https://github.com/microsoft/TypeScript), [pnpm](https://github.com/pnpm/pnpm), and [viem](https://github.com/wagmi-dev/viem). To get started:
44

55
```sh
66
# Install dependencies.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Diff EVM-compatible chains in a friendly format.
66

77
## Overview
88

9-
There's lot of EVM-compatible chains, and they can differ in various, subtle ways.
10-
Developers write contracts intended to be deployed on multiple chains, and therefore need to be aware of these differences.
9+
There are lots of EVM-compatible chains, and they can differ in various, subtle ways.
10+
Developers write contracts intended to be deployed on multiple chains and therefore need to be aware of these differences.
1111

1212
Currently finding this information can be tedious because:
1313

@@ -17,19 +17,19 @@ Currently finding this information can be tedious because:
1717

1818
As L2s aim to scale horizontally with more chains (such as the [Optimism Superchain](https://app.optimism.io/superchain) and new [Arbitrum chains](https://docs.arbitrum.foundation/new-arb-chains)), developers will want to compare those chains against both the "base" optimism/arbitrum chains, and Ethereum mainnet.
1919

20-
Sites like [op-geth](https://op-geth.optimism.io/) are excellent for comparing the actual code, but for smart contract and application developers this is too low-level to be easily digestible.
20+
Sites like [op-geth](https://op-geth.optimism.io/) are excellent for comparing the actual code, but for smart contract and application developers, this is too low-level to be easily digestible.
2121

2222
EVM Diff aims to solve these problems, by allowing you to diff the execution-level specifications of EVM-compatible chains in an easy-to-read format.
2323

2424
## Status
2525

2626
This project is in the early stages of development, and should not yet be relied on.
2727

28-
The initial goal is to have a full diff between mainnet, Optimism, and Arbitrum, and then expand to other chains from there. Starting with these chains seems ideal because they have good documentation are the most popular L2s (by [TVL](https://l2beat.com/scaling/tvl)).
28+
The initial goal is to have a full diff between mainnet, Optimism, and Arbitrum, and then expand to other chains from there. Starting with these chains seems ideal because they have good documentation and they are the most popular L2s (by [TVL](https://l2beat.com/scaling/tvl)).
2929

3030
See the open [issues](https://github.com/mds1/evm-diff/issues) for current needs, and feel free to create new issues for bugs, feature requests, or other ideas.
3131

3232
If you want to contribute, please see [CONTRIBUTING.md](./CONTRIBUTING.md).
33-
**Some issues have bounties attached**, which will paid out on Optimism in OP tokens.[^1] Please be sure to read [CONTRIBUTING.md](./CONTRIBUTING.md) to understand how the bounty process works.
33+
**Some issues have bounties attached**, which will be paid out on Optimism in OP tokens.[^1] Please be sure to read [CONTRIBUTING.md](./CONTRIBUTING.md) to understand how the bounty process works.
3434

3535
[^1]: Thanks to Optimism RPGF, as these bounties were made possible by an [RPGF grant](https://optimism.mirror.xyz/Upn_LtV2-3SviXgX_PE_LyA7YI00jQyoM1yf55ltvvI) I received for [Multicall3](https://github.com/mds1/multicall).

0 commit comments

Comments
 (0)