Skip to content

Commit

Permalink
docs: demo test information
Browse files Browse the repository at this point in the history
  • Loading branch information
wdavidw committed Dec 13, 2021
1 parent c638ca5 commit 8ea0657
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 1 deletion.
8 changes: 8 additions & 0 deletions demo/browser/README.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 3 additions & 1 deletion demo/cjs/README.md
Original file line number Diff line number Diff line change
@@ -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`.
8 changes: 8 additions & 0 deletions demo/esm/README.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions demo/webpack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 8ea0657

Please sign in to comment.