From 69abbc6fd3bac97ed8ff45fce1014c8499fc5e32 Mon Sep 17 00:00:00 2001 From: Ravi theja Date: Wed, 17 Jan 2024 15:32:31 +0530 Subject: [PATCH] feat: update readme, package.json --- README.md | 24 ++++---------------- packages/hls-player/package.json | 5 ++++ packages/hls-stats/package.json | 5 ++++ packages/hms-video-store/package.json | 5 ++++ packages/hms-virtual-background/package.json | 12 +++++++--- packages/react-icons/package.json | 5 ++++ packages/react-sdk/package.json | 5 ++++ packages/roomkit-react/package.json | 5 ++++ packages/roomkit-web/package.json | 5 ++++ 9 files changed, 49 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index dd8aa847fe..cc1e57c5a4 100644 --- a/README.md +++ b/README.md @@ -6,35 +6,21 @@ This monorepo contains all the packages required to integrate 100ms on web ### Local Setup -Clone the repo locally and run yarn install +> Node version 18.0.0 or later + +if you are using a different version in other projects, use [nvm](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating) to manage node versions. + ``` git clone https://github.com/100mslive/web-sdks.git cd web-sdks yarn install -``` - -### Test - -``` -yarn test -``` - -### Lint - -Runs eslint across all packages - -``` -yarn lint +yarn build ``` ### Running Sample Prebuilt ``` -# do this at the root level -yarn install -yarn build - cd examples/prebuilt-react-integration yarn dev ``` diff --git a/packages/hls-player/package.json b/packages/hls-player/package.json index a3347d00c7..febc820dd1 100644 --- a/packages/hls-player/package.json +++ b/packages/hls-player/package.json @@ -5,6 +5,11 @@ "main": "dist/index.cjs.js", "module": "dist/index.js", "typings": "dist/index.d.ts", + "repository": { + "type": "git", + "url": "https://github.com/100mslive/web-sdks.git", + "directory": "packages/hls-player" + }, "files": [ "src", "dist" diff --git a/packages/hls-stats/package.json b/packages/hls-stats/package.json index b70f646cbd..90e89af7a5 100644 --- a/packages/hls-stats/package.json +++ b/packages/hls-stats/package.json @@ -5,6 +5,11 @@ "main": "dist/index.cjs.js", "module": "dist/index.js", "typings": "dist/index.d.ts", + "repository": { + "type": "git", + "url": "https://github.com/100mslive/web-sdks.git", + "directory": "packages/hls-stats" + }, "files": [ "src", "dist" diff --git a/packages/hms-video-store/package.json b/packages/hms-video-store/package.json index c59fe00d9a..17a4d10537 100644 --- a/packages/hms-video-store/package.json +++ b/packages/hms-video-store/package.json @@ -1,6 +1,11 @@ { "version": "0.11.1-alpha.1", "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/100mslive/web-sdks.git", + "directory": "packages/hms-video-store" + }, "main": "dist/index.cjs.js", "module": "dist/index.js", "typings": "dist/index.d.ts", diff --git a/packages/hms-virtual-background/package.json b/packages/hms-virtual-background/package.json index 03c148ea9c..c4ab78373d 100755 --- a/packages/hms-virtual-background/package.json +++ b/packages/hms-virtual-background/package.json @@ -1,8 +1,16 @@ { "version": "1.12.1-alpha.1", "license": "MIT", + "name": "@100mslive/hms-virtual-background", + "author": "100ms", + "module": "dist/index.js", "main": "dist/index.cjs.js", "typings": "dist/index.d.ts", + "repository": { + "type": "git", + "url": "https://github.com/100mslive/web-sdks.git", + "directory": "packages/hms-virtual-background" + }, "files": [ "dist", "src/tflite", @@ -26,9 +34,7 @@ "peerDependencies": { "@100mslive/hms-video-store": "0.11.1-alpha.1" }, - "name": "@100mslive/hms-virtual-background", - "author": "ashish17", - "module": "dist/index.js", + "devDependencies": { "@100mslive/hms-video-store": "0.11.1-alpha.1" }, diff --git a/packages/react-icons/package.json b/packages/react-icons/package.json index 5ac2b0ef79..c2d5169c5b 100644 --- a/packages/react-icons/package.json +++ b/packages/react-icons/package.json @@ -7,6 +7,11 @@ "version": "0.9.1-alpha.1", "author": "100ms", "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/100mslive/web-sdks.git", + "directory": "packages/react-icons" + }, "files": [ "dist", "src" diff --git a/packages/react-sdk/package.json b/packages/react-sdk/package.json index 36ca0dc226..c7e3320b16 100644 --- a/packages/react-sdk/package.json +++ b/packages/react-sdk/package.json @@ -7,6 +7,11 @@ "version": "0.9.1-alpha.1", "author": "100ms", "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/100mslive/web-sdks.git", + "directory": "packages/react-sdk" + }, "files": [ "dist", "src" diff --git a/packages/roomkit-react/package.json b/packages/roomkit-react/package.json index 88db8dd6d0..70bd0fc852 100644 --- a/packages/roomkit-react/package.json +++ b/packages/roomkit-react/package.json @@ -13,6 +13,11 @@ "version": "0.2.1-alpha.1", "author": "100ms", "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/100mslive/web-sdks.git", + "directory": "packages/roomkit-react" + }, "files": [ "dist", "src" diff --git a/packages/roomkit-web/package.json b/packages/roomkit-web/package.json index 1b0198596b..c1ed51e5c6 100644 --- a/packages/roomkit-web/package.json +++ b/packages/roomkit-web/package.json @@ -13,6 +13,11 @@ "typings": "dist/index.d.ts", "author": "100ms", "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/100mslive/web-sdks.git", + "directory": "packages/roomkit-web" + }, "files": [ "dist" ],