Merge branch 'main' into model-handpose

Author: ziyuan-linn

CONTRIBUTING.md

@@ -25,9 +25,9 @@ You should see something similar to this in the terminal:
 webpack 5.76.1 compiled successfully in 8360 ms
 ```
 
-A local server have been started and hosts a built version of the ml5 library at http://localhost:8080/ml5.js. While the server is running, Webpack will automatically rebuild the library if you change and save any file in the `/src` folder.
+A local server have been started and hosts a built version of the ml5 library at http://localhost:8080/dist/ml5.js. While the server is running, Webpack will automatically rebuild the library if you change and save any file in the `/src` folder.
 
-Open `examples/NeuralNetwork/index.html` in the browser to see the live build of `ml5.js` working in some example code.
+A webpage at http://localhost:8080/examples/ should automatically open with the directory listing of the example directory. Select one of the directories to test run `ml5.js` in some example code.
 
 ## Code Formatting
 

LICENSE.md

@@ -0,0 +1,49 @@
+# ml5.js LICENSE
+
+_Version 1.0 of the ml5.js license was adopted and last updated on May 10, 2021. It applies to all contributions to the ml5.js library as of May 20,2021. Contributions prior to that date are licensed under the MIT license. You can read the blog post announcing and explaining the development of the license [here](https://ml5js.medium.com/6b0e4c109b76)._
+
+## Purpose
+
+This license gives everyone as much permission to work with this software as possible as long as they comply with the ml5.js [Code of Conduct](https://github.com/ml5js/Code-of-Conduct), while protecting contributors from liability.
+
+## Acceptance
+
+In order to receive this license, you must agree to its rules. The rules of this license are both obligations under that agreement and conditions to your license. You must not do anything with this software that triggers a rule that you cannot or will not follow.
+
+## Copyright
+
+Each contributor licenses you to do everything with this software that would otherwise infringe that contributor’s copyright in it.
+
+## License Reversion
+
+Each contribution to this software is licensed under this license for three years from the date it is contributed to the software. After that three year period the contribution is licensed under the [Blue Oak Model License v 1.0.0](https://blueoakcouncil.org/license/1.0.0).
+
+## Code of Conduct
+
+You must use this software in compliance with the ml5.js [Code of Conduct](https://github.com/ml5js/Code-of-Conduct) as it exists at the time of your use. This includes cooperating with any investigations of your compliance with the ml5.js Code of Conduct.
+
+## Notices
+
+You must ensure that everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license or a link to https://ml5js.org/license.
+
+## Excuse
+
+If anyone notifies you in writing that you have not complied with [Notices](https://github.com/ml5js/Code-of-Conduct/blob/main/LICENSE.md#notices), you can keep your license by taking all practical steps to comply within 30 days after the notice. If you do not do so, your license ends immediately.
+
+If anyone notifies you in writing that you have not complied with the Code of Conduct, you can keep your license by taking all practical steps to comply within 30 days after the notice. If you do not do so, and the ml5.js Code of Conduct Committee (or its equivalent or successor) agrees that you are in violation of the Code of Conduct, your license ends immediately.
+
+## Patent
+
+Each contributor licenses you to do everything with this software that would otherwise infringe any patent claims they can license or become able to license.
+
+## Reliability
+
+No contributor can revoke this license.
+
+## No Liability
+
+**_As far as the law allows, this software comes as is, without any warranty or condition, and no contributor will be liable to anyone for any damages related to this software or this license, under any kind of legal claim._**
+
+## Permission
+
+Each contributor licenses you to do everything with this license that would otherwise infringe that contributor’s copyright in it.

README.md

@@ -29,6 +29,6 @@ You should see something similar to this in the terminal:
 webpack 5.76.1 compiled successfully in 8360 ms
 ```
 
-A local server have been started and hosts a built version of the ml5 library at http://localhost:8080/ml5.js. While the server is running, Webpack will automatically rebuild the library if you change and save any file in the `/src` folder.
+A local server have been started and hosts a built version of the ml5 library at http://localhost:8080/dist/ml5.js. While the server is running, Webpack will automatically rebuild the library if you change and save any file in the `/src` folder.
 
-Open `examples/NeuralNetwork/index.html` in the browser to see the live build of `ml5.js` working in some example code.
+A webpage at http://localhost:8080/examples/ should automatically open with the directory listing of the example directory. Select one of the directories to test run `ml5.js` in some example code.

examples/NeuralNetwork/index.html

@@ -5,7 +5,7 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Document</title>
-    <script src="http://localhost:8080/ml5.js"></script>
+    <script src="../../dist/ml5.js"></script>
   </head>
   <body>
     <script src="script.js"></script>

webpack.config.js

@@ -11,7 +11,7 @@ module.exports = function (env, argv) {
     output: {
       filename: "ml5.js",
       path: resolve(__dirname, "dist"),
-      publicPath: "/",
+      publicPath: "/dist/",
       library: {
         name: "ml5",
         type: "umd",
@@ -21,10 +21,19 @@ module.exports = function (env, argv) {
     devServer: {
       port: 8080,
       allowedHosts: "all",
-      static: {
-        directory: resolve(__dirname, "dist"),
-        watch: true,
-      },
+      static: [
+        {
+          directory: resolve(__dirname, "dist"),
+          publicPath: "/dist",
+          watch: true,
+        },
+        {
+          directory: resolve(__dirname, "examples"),
+          publicPath: "/examples",
+          watch: true,
+        },
+      ],
+      open: "/examples",
     },
     plugins: [
       new HtmlWebpackPlugin({