diff --git a/docs/dev/shipped-files.md b/docs/dev/shipped-files.md new file mode 100644 index 000000000..e2e02dc20 --- /dev/null +++ b/docs/dev/shipped-files.md @@ -0,0 +1,8 @@ +# Shipped files + +Of cause, we ship the build results (JavaScript and type definitions). + +We also ship our sources (TypeScript), so that downstream users can work with them directly with own compilers/builders/packers. +And we ship all the build instructions we used. +Background: our source code requires some special TypeScript compiler options; downstream users might need our special build options, when they work with our shipped sources. (see also: ) +We manage our shipped files in a [`.npmignore`](../../.npmignore) file.