tornado-packages/ethers.js
1
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: updated post-build folder docs

Browse Source
This commit is contained in:
Richard Moore 2023-02-04 08:24:19 -05:00
parent 24e13fc0f2
commit 8d5a13faea
4 changed files with 64 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
output/post-build/dist/README.md vendored Normal file
View File

@ -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`.

16
output/post-build/lib.commonjs/README.md
View File

@ -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`.

16
output/post-build/lib.esm/README.md
View File

@ -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`.

16
output/post-build/types/README.md Normal file
View File

@ -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`.