speaker-calibration 1.0.6 → 1.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README +3 -0
  2. package/README.md +5 -26
  3. package/dist/main.js +1 -1
  4. package/package.json +1 -4
package/README ADDED
@@ -0,0 +1,3 @@
1
+ # Speaker-Calibration: Javascript Speaker Calibration Library for Auditory Testing
2
+
3
+ Speaker-Calibration provides a simple API for performing speaker calibration in Javascript. The Library has minimal dependencies and is designed to be used in the browser.
package/README.md CHANGED
@@ -1,10 +1,6 @@
1
1
  # Speaker-Calibration
2
2
 
3
- [![Netlify Status](https://api.netlify.com/api/v1/badges/4662ab8c-dd4f-43ce-8e2d-add7a406300a/deploy-status)](https://app.netlify.com/sites/focused-hodgkin-0a6531/deploys)
4
-
5
- # Contribution Guidelines
6
-
7
- _As of 03/01/2022_
3
+ _As of 04/06/2022_
8
4
 
9
5
  ## Initial Setup
10
6
 
@@ -15,30 +11,18 @@ _As of 03/01/2022_
15
11
  ## Local Development
16
12
 
17
13
  All outputs from the scripts/recipies below should be automatically placed in the `/dist` directory.
18
- This is what will be served once the library is published.
19
-
20
- ### Example
21
-
22
- In `/dist/example` you will find a small example app that uses the `speaker-calibration` library.
23
14
 
24
15
  ### Javascript
25
-
26
16
  In `package.json` you will see some key scripts:
27
17
 
28
- 1. `build:wasm` cleans and rebuilds the wasm files
18
+ 1. `build:prod` - tells webpack to build the library for production.
29
19
  2. `build:dev` tells webpack to build the `speaker-calibration` library in development watch mode,
30
20
  outputing to `/dist`
31
- 3. `serve:dev` spins up an `express.js` server on port `3000` using `nodemon`. It serves the
32
- `/dist` & `/dist/example` folders.
21
+ 3. `build:wasm` cleans and rebuilds the wasm files
33
22
  4. `lint` runs `eslint` on all js files in the project
34
23
  5. `lint:fix` lints and automatically fixes all js files in the project.
35
24
  6. `build:doc` builds the documentation using `jsdoc`. Outputs to `/doc`
36
-
37
- Run `(1)` & `(2)` in seperate shell windows, with this setup you will be able to modify both the
38
- library and front end examples with hot reload built in. `(3)` provides a simple abstraction on the
39
- `makefile` recipies below. Run `(5)` precommit to keep you code standardized.
40
-
41
- TODO Make `(5)` a precommit hook
25
+ 7. `test` runs all tests in the project.
42
26
 
43
27
  ### CPP/WASM
44
28
 
@@ -57,7 +41,7 @@ requires the installation of the Emscriten compiler. Instructions can be found o
57
41
 
58
42
  We use [jsdoc](https://jsdoc.app/) standards to document our library.
59
43
 
60
- ### Listing
44
+ ### Linting
61
45
 
62
46
  We use [ESLint](https://eslint.org/) to lint our code and enforce best practices. We are currently
63
47
  using [AirBnB's JavaScript Style Guide](https://airbnb.io/javascript/)
@@ -65,8 +49,3 @@ using [AirBnB's JavaScript Style Guide](https://airbnb.io/javascript/)
65
49
  ### Styling
66
50
 
67
51
  We use [Prettier](https://prettier.io/) to format our code.
68
-
69
- ## Deployment
70
-
71
- Changes publshed to `main` will automatically trigger a deploy on the `netlify` project TODO: Fix
72
- netlify deploy not serving the /dist & /example folders