diff --git a/README.md b/README.md index 6b9bc6d7..78226023 100755 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Check out this Twitter thread for an illustrated list of features: https://twitt Its possible to use Webamp as a media player on your own website. In fact, the [Internet Archive](https://archive.org/) offers it as an optional player for all of their archived audio tracks. [Read more](https://blog.archive.org/2018/10/02/dont-click-on-the-llama/). -For examples of how to add Webamp to your projects, check out out [`examples/` directory](./packages/webamp/examples). +For examples of how to add Webamp to your projects, check out out [`examples/` directory](./examples). See the [usage documentation](./packages/webamp/docs/usage.md) for more detailed information. @@ -31,7 +31,7 @@ This repository contains a number of different things: 1. `packages/webamp`: The code for the [Webamp NPM module](https://www.npmjs.com/package/webamp) 2. `packages/webamp/demo`: The code for the demo site which lives at [webamp.org](https://webamp.org), see the next section for more details -3. `packages/webamp/examples`: A few small examples showing how to use the NPM module +3. `examples`: A few small examples showing how to use the NPM module 4. `packages/*`: A few small projects that are either related to Webamp, or may some day be a part of Webamp ## About the Demo Site diff --git a/packages/webamp/examples/minimal/README.md b/examples/minimal/README.md similarity index 100% rename from packages/webamp/examples/minimal/README.md rename to examples/minimal/README.md diff --git a/packages/webamp/examples/minimal/index.html b/examples/minimal/index.html similarity index 100% rename from packages/webamp/examples/minimal/index.html rename to examples/minimal/index.html diff --git a/packages/webamp/examples/minimalMilkdrop/README.md b/examples/minimalMilkdrop/README.md similarity index 100% rename from packages/webamp/examples/minimalMilkdrop/README.md rename to examples/minimalMilkdrop/README.md diff --git a/packages/webamp/examples/minimalMilkdrop/index.html b/examples/minimalMilkdrop/index.html similarity index 100% rename from packages/webamp/examples/minimalMilkdrop/index.html rename to examples/minimalMilkdrop/index.html diff --git a/packages/webamp/examples/readme.md b/examples/readme.md similarity index 100% rename from packages/webamp/examples/readme.md rename to examples/readme.md diff --git a/packages/webamp/examples/webpack/README.md b/examples/webpack/README.md similarity index 100% rename from packages/webamp/examples/webpack/README.md rename to examples/webpack/README.md diff --git a/packages/webamp/examples/webpack/index.html b/examples/webpack/index.html similarity index 100% rename from packages/webamp/examples/webpack/index.html rename to examples/webpack/index.html diff --git a/packages/webamp/examples/webpack/index.js b/examples/webpack/index.js similarity index 100% rename from packages/webamp/examples/webpack/index.js rename to examples/webpack/index.js diff --git a/packages/webamp/examples/webpack/package.json b/examples/webpack/package.json similarity index 100% rename from packages/webamp/examples/webpack/package.json rename to examples/webpack/package.json diff --git a/packages/webamp/examples/webpackLazyLoad/README.md b/examples/webpackLazyLoad/README.md similarity index 100% rename from packages/webamp/examples/webpackLazyLoad/README.md rename to examples/webpackLazyLoad/README.md diff --git a/packages/webamp/examples/webpackLazyLoad/index.html b/examples/webpackLazyLoad/index.html similarity index 100% rename from packages/webamp/examples/webpackLazyLoad/index.html rename to examples/webpackLazyLoad/index.html diff --git a/packages/webamp/examples/webpackLazyLoad/index.js b/examples/webpackLazyLoad/index.js similarity index 100% rename from packages/webamp/examples/webpackLazyLoad/index.js rename to examples/webpackLazyLoad/index.js diff --git a/packages/webamp/examples/webpackLazyLoad/package.json b/examples/webpackLazyLoad/package.json similarity index 90% rename from packages/webamp/examples/webpackLazyLoad/package.json rename to examples/webpackLazyLoad/package.json index c488a2dc..ed48b893 100644 --- a/packages/webamp/examples/webpackLazyLoad/package.json +++ b/examples/webpackLazyLoad/package.json @@ -1,5 +1,5 @@ { - "name": "webamp-webpack-example", + "name": "webamp-webpack-lazy-example", "version": "0.0.0", "description": "An example of using Webamp within a Webpack bundle", "main": "index.js", diff --git a/package.json b/package.json index 457589a9..985b8e7a 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,8 @@ "name": "webamp-monorepo", "private": true, "workspaces": [ - "packages/*" + "packages/*", + "examples/*" ], "scripts": { "deploy": "yarn workspace webamp build && yarn workspace webamp build-library" diff --git a/yarn.lock b/yarn.lock index ee413490..9a6294bb 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3881,6 +3881,15 @@ enhanced-resolve@^4.1.0: memory-fs "^0.5.0" tapable "^1.0.0" +enhanced-resolve@^4.1.1: + version "4.2.0" + resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-4.2.0.tgz#5d43bda4a0fd447cb0ebbe71bef8deff8805ad0d" + integrity sha512-S7eiFb/erugyd1rLb6mQ3Vuq+EXHv5cpCkNqqIkYkBgN2QdFnyCZzFBleqwGEx4lgNGYij81BWnCrFNK7vxvjQ== + dependencies: + graceful-fs "^4.1.2" + memory-fs "^0.5.0" + tapable "^1.0.0" + entities@^1.1.1, entities@~1.1.1: version "1.1.2" resolved "https://registry.yarnpkg.com/entities/-/entities-1.1.2.tgz#bdfa735299664dfafd34529ed4f8522a275fea56" @@ -3999,6 +4008,11 @@ eslint-plugin-prettier@^3.1.0: dependencies: prettier-linter-helpers "^1.0.0" +eslint-plugin-react-hooks@^1.5.1: + version "1.7.0" + resolved "https://registry.yarnpkg.com/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-1.7.0.tgz#6210b6d5a37205f0b92858f895a4e827020a7d04" + integrity sha512-iXTCFcOmlWvw4+TOE8CLWj6yX1GwzT0Y6cUfHHZqWnSk144VmVIRcVGtUAzrLES7C798lmvnt02C7rxaOX1HNA== + eslint-plugin-react-hooks@^2.1.2: version "2.5.1" resolved "https://registry.yarnpkg.com/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-2.5.1.tgz#4ef5930592588ce171abeb26f400c7fbcbc23cd0" @@ -4957,7 +4971,7 @@ glob@^7.0.3, glob@^7.1.1, glob@^7.1.2, glob@^7.1.3, glob@^7.1.4, glob@^7.1.6: once "^1.3.0" path-is-absolute "^1.0.0" -global-modules@2.0.0: +global-modules@2.0.0, global-modules@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/global-modules/-/global-modules-2.0.0.tgz#997605ad2345f27f51539bea26574421215c7780" dependencies: @@ -5651,6 +5665,11 @@ interpret@1.2.0: version "1.2.0" resolved "https://registry.yarnpkg.com/interpret/-/interpret-1.2.0.tgz#d5061a6224be58e8083985f5014d844359576296" +interpret@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/interpret/-/interpret-1.4.0.tgz#665ab8bc4da27a774a40584e812e3e0fa45b1a1e" + integrity sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA== + interpret@^2.0.0: version "2.2.0" resolved "https://registry.yarnpkg.com/interpret/-/interpret-2.2.0.tgz#1a78a0b5965c40a5416d007ad6f50ad27c417df9" @@ -10670,6 +10689,11 @@ v8-compile-cache@^2.0.3: version "2.1.0" resolved "https://registry.yarnpkg.com/v8-compile-cache/-/v8-compile-cache-2.1.0.tgz#e14de37b31a6d194f5690d67efc4e7f6fc6ab30e" +v8-compile-cache@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/v8-compile-cache/-/v8-compile-cache-2.1.1.tgz#54bc3cdd43317bca91e35dcaf305b1a7237de745" + integrity sha512-8OQ9CL+VWyt3JStj7HX7/ciTL2V3Rl1Wf5OL+SNTm0yK1KvtReVulksyeRnCANHHuUxHlQig+JJDlUhBt1NQDQ== + v8flags@^3.1.1: version "3.1.3" resolved "https://registry.yarnpkg.com/v8flags/-/v8flags-3.1.3.tgz#fc9dc23521ca20c5433f81cc4eb9b3033bb105d8" @@ -10767,6 +10791,14 @@ wbuf@^1.1.0, wbuf@^1.7.3: dependencies: minimalistic-assert "^1.0.0" +webamp@1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/webamp/-/webamp-1.4.0.tgz#36c0ef2621ed3d14835d8cbd58206a408903e602" + integrity sha512-4pQjpPRtSI1Bde2YAIQfE3FOOY17YnVdn/et8jW5pxs788MKuDMVYgs8Iz1Tqn6mGh/u2lH3kF6I3hmyKDC/FA== + dependencies: + eslint-plugin-react-hooks "^1.5.1" + fscreen "^1.0.2" + webidl-conversions@^4.0.2: version "4.0.2" resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-4.0.2.tgz#a855980b1f0b6b359ba1d5d9fb39ae941faa63ad" @@ -10805,6 +10837,23 @@ webpack-cli@^3.1.2: v8-compile-cache "2.0.3" yargs "13.2.4" +webpack-cli@^3.3.0: + version "3.3.12" + resolved "https://registry.yarnpkg.com/webpack-cli/-/webpack-cli-3.3.12.tgz#94e9ada081453cd0aa609c99e500012fd3ad2d4a" + integrity sha512-NVWBaz9k839ZH/sinurM+HcDvJOTXwSjYp1ku+5XKeOC03z8v5QitnK/x+lAxGXFyhdayoIf/GOpv85z3/xPag== + dependencies: + chalk "^2.4.2" + cross-spawn "^6.0.5" + enhanced-resolve "^4.1.1" + findup-sync "^3.0.0" + global-modules "^2.0.0" + import-local "^2.0.0" + interpret "^1.4.0" + loader-utils "^1.4.0" + supports-color "^6.1.0" + v8-compile-cache "^2.1.1" + yargs "^13.3.2" + webpack-dev-middleware@^3.7.2: version "3.7.2" resolved "https://registry.yarnpkg.com/webpack-dev-middleware/-/webpack-dev-middleware-3.7.2.tgz#0019c3db716e3fa5cecbf64f2ab88a74bab331f3" @@ -10873,7 +10922,7 @@ webpack-sources@^1.4.0, webpack-sources@^1.4.1: source-list-map "^2.0.0" source-map "~0.6.1" -webpack@^4.41.2: +webpack@^4.29.6, webpack@^4.41.2: version "4.43.0" resolved "https://registry.yarnpkg.com/webpack/-/webpack-4.43.0.tgz#c48547b11d563224c561dad1172c8aa0b8a678e6" dependencies: