Skip to content

Commit

Permalink
docs: updated post-build folder docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ricmoo committed Feb 4, 2023
1 parent 24e13fc commit 8d5a13f
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 6 deletions.
22 changes: 22 additions & 0 deletions output/post-build/dist/README.md
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`.
16 changes: 13 additions & 3 deletions output/post-build/lib.commonjs/README.md
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`.
16 changes: 13 additions & 3 deletions output/post-build/lib.esm/README.md
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`.
16 changes: 16 additions & 0 deletions output/post-build/types/README.md
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`.

0 comments on commit 8d5a13f

Please sign in to comment.