diff --git a/demo/browser/README.md b/demo/browser/README.md new file mode 100644 index 000000000..96081bedb --- /dev/null +++ b/demo/browser/README.md @@ -0,0 +1,8 @@ + +# Native browser + +The package illustrates the native integration of the CSV packages in a browser environnment. + +## Testing + +There are no test for this package. The only way is to start the server and navigate the pages. We could use headless browser tests. diff --git a/demo/cjs/README.md b/demo/cjs/README.md index e6efbda1c..1f7649490 100644 --- a/demo/cjs/README.md +++ b/demo/cjs/README.md @@ -1,8 +1,10 @@ # Node.js CSV demo for CommonJS -The package exposes a few JavaScript and TypeScript examples to import the CSV parser using the CommonJS module loader. +The package illustrates the usage of CommonJS modules inside a Node.js environment. It uses JavaScript and TypeScript. ## Testing +The test suite execute each sample present in the `./lib` folder. + For Node.js 12 and above, run `yarn test`. For versions below 12 and above 8, run `./test/node8.sh`. diff --git a/demo/esm/README.md b/demo/esm/README.md new file mode 100644 index 000000000..4c8b72c7c --- /dev/null +++ b/demo/esm/README.md @@ -0,0 +1,8 @@ + +# ESM demo + +The package illustrates the usage of ESM inside a Node.js environment. It uses JavaScript and TypeScript. + +## Testing + +The test suite execute each sample present in the `./lib` folder. diff --git a/demo/webpack/README.md b/demo/webpack/README.md index 626788cee..17161efd6 100644 --- a/demo/webpack/README.md +++ b/demo/webpack/README.md @@ -37,3 +37,7 @@ npx http-server ./dist -p 8080 ``` The web application is now accessible on [`https://localhost:8080`](https://localhost:8080). + +## Testing + +The test suite consists in building the code with webpack. We don't check if the code is working.