uneeq-js 3.0.16-preview.6 → 3.0.16-preview.9

package/README.md

@@ -8,6 +8,10 @@ This project is a web npm package used to connect to Uneeq's Digital Human Orche
 #### Start:
 `npm start`
 
+#### Local testing
+
+See [./example/README.md](./example/README.md)
+
 #### Lint
 Eslint is used in this project and can be run with `npm run lint`. You may find it easier to install VSCode plugin `eslint` to see lint errors in editor. Additionally adding the following option to the plugin settings will fix errors on save:
 
@@ -15,7 +19,23 @@ Eslint is used in this project and can be run with `npm run lint`. You may find
     "source.fixAll.eslint": true
 }`
 
+#### Logging
+A custom logger has been implemented using `pino` library. You can use it to log strings with values.
+`Logger.info('Logging just a string')`
+`Logger.info('Logging with value', { some: 'thing' })`
+`Logger.info('Logging with multiple values', { some: 'thing' }, { another: 'thing' })`
+
+There are multiple log levels which are defined in `src/types/LogLevels.ts`:
+`Logger.debug('a debug log')`
+`Logger.info('an info log')`
+`Logger.warn('a warning log')`
+`Logger.error('an error log')`
+
+Logs will only be displayed if they are at or above the log level specified when initializing the Uneeq class via UneeqConfig. The default log level is 'info'.
+
+Log messages will be prefixed with the string 'UneeQ: ' so that uneeq-js logs can be differentiated from client logs easily.
+
 
 ## Notes
 #### onnxruntime-web
-onnxruntime-web only works on version 1.15.1 at this time. Upgrading this package will likely break VAD funtionality.
+onnxruntime-web only works on version 1.15.1 at this time. Upgrading this package will likely break VAD funtionality.