Skip to content

Commit

Permalink
README + bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
mknxdev committed Aug 6, 2023
1 parent 8e65808 commit 3814ab6
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
14 changes: 13 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [1.0.0-beta.1] - 2023-07-21
## [1.0.0-beta.3] - 2023-08-06

### Added

- `verbose` option to display more debug informations

## [1.0.0-beta.2] - 2023-08-05

### Changed

- Improved docs

## [1.0.0-beta.1] - 2023-08-03

### Added

Expand Down
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ jTester({
})
```

All configuration options are described below.
All available configuration options are described below.

### autorun

Expand All @@ -98,6 +98,18 @@ All configuration options are described below.
By default, code tests will be executed on-the-fly right away after they are defined through the `.test` method.
By setting this option to `false`, code tests will be simply stored and prepared for execution. In this case the execution must be triggered manually with the `.run` method.

### verbose

| type | default |
|---------|---------|
| boolean | false |

**Displays advanced informations about system and code tests.**

Set to `false` by default, it can be enabled to display advanced debug informations, like system and hardware-related infos.

> **Note:** Some system or hardware-related informations are based on browser properties that are not 100% reliable (typically `User-Agent`) because they can be changed by the user.
## Public API

Here is the full list of the public properties and methods exposed by the jTester instance.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jtester-tool",
"version": "1.0.0-beta.2",
"version": "1.0.0-beta.3",
"description": "Lightweight JavaScript code performance testing utility for web browsers and Node.js.",
"keywords": [
"nodejs",
Expand Down

0 comments on commit 3814ab6

Please sign in to comment.