-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: updated post-build folder docs
- Loading branch information
Showing
4 changed files
with
64 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Distribution Folder | ||
=================== | ||
|
||
The contents of this folder are for using `import` in ESM | ||
browser-base projects. | ||
|
||
The `ethers.js` (and `ethers.min.js`) files only include the | ||
English wordlist to conserve space. | ||
|
||
For additional Wordlist support, the `wordlist-extra.js` (and | ||
`wordlist-extra.min.js`) should be imported too. | ||
|
||
|
||
Notes | ||
----- | ||
|
||
The contents are generated via the `npm build dist` target using | ||
`rollup` and the `/rollup.config.js` configuration. | ||
|
||
Do not modify the files in this folder. They are deleted on `build-clean`. | ||
|
||
To modify this `README.md`, see the `/output/post-build/dist`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,16 @@ | ||
CommonJS Generated Files | ||
======================== | ||
CommonJS Files | ||
============== | ||
|
||
The contents of this folder are for using `require` in CommonJS | ||
projects. | ||
|
||
|
||
Notes | ||
----- | ||
|
||
The contents are generated via the `npm run build-commonjs` target | ||
using `tsc` and the `/tsconfig.commonjs.json` configuration. | ||
|
||
Do not modify the files in this folder. They are deleted on `build-clean`. | ||
|
||
These files are generated from the `/tsconfig.commonjs.json` | ||
To modify this `README.md`, see the `/output/post-build/lib.commonjs`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,16 @@ | ||
ESM Generated Files | ||
=================== | ||
ESM Files | ||
========= | ||
|
||
The contents of this folder are for using `import` in ESM | ||
projects. | ||
|
||
|
||
Notes | ||
----- | ||
|
||
The contents are generated via the `npm run build` target | ||
using `tsc` and the `/tsconfig.esm.json` configuration. | ||
|
||
Do not modify the files in this folder. They are deleted on `build-clean`. | ||
|
||
These files are generated from the `/tsconfig.esm.json` | ||
To modify this `README.md`, see the `/output/post-build/lib.esm`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
TypeScript Type Definitions | ||
=========================== | ||
|
||
The contents of this folder are the TypeScript definirtions for | ||
TypeScript projects. | ||
|
||
|
||
Notes | ||
----- | ||
|
||
The contents are generated via the `npm run build-types` target | ||
using `tsc` and the `/tsconfig.types.json` configuration. | ||
|
||
Do not modify the files in this folder. They are deleted on `build-clean`. | ||
|
||
To modify this `README.md`, see the `/output/post-build/types`. |