Skip to content

Commit f33ce2b

Browse files
authored
Merge pull request #4959 from NomicFoundation/edr/readme-and-package-json-files
Add readme and add files entry to package.json
2 parents 375f26d + b812384 commit f33ce2b

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

crates/edr_napi/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# EDR - Ethereum Development Runtime
2+
3+
**EDR**, or **Ethereum Development Runtime** in full, is a library for creating developer tooling on top of the Ethereum Virtual Machine (EVM), such as an EVM debugger or state inspector.
4+
EDR provides a performant API, written in Rust, with bindings for the Node API (TypeScript).
5+
6+
At the moment, EDR is only meant to be consumed from [Hardhat](https://hardhat.org/), but we plan to have a stable API that can be used from any other tooling. If you are interested in this, please reach out.

crates/edr_napi/package.json

+7
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
"version": "0.2.0",
44
"main": "index.js",
55
"types": "index.d.ts",
6+
"files": [
7+
"index.js",
8+
"index.d.ts",
9+
"Cargo.toml",
10+
"build.rs",
11+
"src/"
12+
],
613
"repository": {
714
"url": "https://github.com/NomicFoundation/hardhat.git",
815
"type": "git"

0 commit comments

Comments
 (0)