Skip to content

Commit 306c8a3

Browse files
committed
chore: move size info to the installation page
1 parent a52d9d8 commit 306c8a3

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

packages/client/docusaurus/docs/javascript/01-basics/02-installation.mdx

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Installation
3-
description: Install the client for video calling
2+
title: Installation & Size
3+
description: Installation instructions and bundle size impact for the Plain-JS Video SDK
44
---
55

6-
The installation of the packages for the Stream Video JavaScript Client can be either done with `yarn` or `npm`.
6+
The installation of the packages for the Stream Video Plain-JS SDK can be either done with `yarn`, `npm` or any other package manager.
77

88
For `yarn`:
99

@@ -16,3 +16,10 @@ For `npm`:
1616
```bash
1717
npm install @stream-io/video-client
1818
```
19+
20+
## SDK Size
21+
22+
The SDK size after minification is below 370KB. This size includes all the functionalities provided by the SDK.
23+
After g-zipping, the SDK size can be compressed down to ~100KB.
24+
25+
For most up-to-date information on the SDK size, please check the [package size](https://bundlephobia.com/result?p=@stream-io/video-client) on Bundlephobia.
Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Supported Platforms
2+
title: Supported Platforms and Size
33
description: A list of supported platforms and SDK size information
44
---
55

@@ -13,10 +13,3 @@ Our Plain-JS Video SDK can run on all modern browsers and platforms. Here is a l
1313
## WebView
1414

1515
Our SDK can run in Web View on Android and iOS. However, we recommend using the SDK in a browser for the best experience.
16-
17-
## SDK Size
18-
19-
The SDK size after minification is below 370KB. This size includes all the functionalities provided by the SDK.
20-
After g-zipping, the SDK size can be compressed down to ~100KB.
21-
22-
For most up-to-date information on the SDK size, please check the [package size](https://bundlephobia.com/result?p=@stream-io/video-client) on Bundlephobia.

packages/react-sdk/docusaurus/docs/React/01-basics/02-installation.mdx

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Installation
3-
description: Install the React Video SDK
2+
title: Installation & Size
3+
description: Installation instructions and bundle size impact for the React Video SDK
44
---
55

6-
The installation of the packages for the Stream Video React SDK can be either done with `yarn` or `npm`.
6+
The installation of the packages for the Stream Video React SDK can be either done with `yarn`, `npm` or any other package manager.
77

88
For `yarn`:
99

@@ -16,3 +16,13 @@ For `npm`:
1616
```bash
1717
npm install @stream-io/video-react-sdk
1818
```
19+
20+
## SDK Size
21+
22+
Our SDK follows the industry standards and is optimized for tree-shaking.
23+
Modern bundlers like Webpack and Rollup can remove the unused code from the SDK, which helps in reducing the bundle size.
24+
25+
The SDK size after minification is below 600KB. This size includes all the components and utilities provided by the SDK.
26+
After g-zipping, the SDK can be compressed down to ~165KB. The actual size of the SDK in your application will depend on the components you use.
27+
28+
For most up-to-date information on the SDK size, please check the [package size](https://bundlephobia.com/result?p=@stream-io/video-react-sdk) on Bundlephobia.

packages/react-sdk/docusaurus/docs/React/01-basics/04-supported-platforms.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,3 @@ Our React Video SDK can run on all modern browsers and platforms. Here is a list
1313
## WebView
1414

1515
Our SDK can run in Web View on Android and iOS. However, we recommend using the SDK in a browser for the best experience.
16-
17-
## SDK Size
18-
19-
Our SDK follows the industry standards and is optimized for tree-shaking.
20-
Modern bundlers like Webpack and Rollup can remove the unused code from the SDK, which helps in reducing the bundle size.
21-
22-
The SDK size after minification is below 600KB. This size includes all the components and utilities provided by the SDK.
23-
After g-zipping, the SDK can be compressed down to ~165KB. The actual size of the SDK in your application will depend on the components you use.
24-
25-
For most up-to-date information on the SDK size, please check the [package size](https://bundlephobia.com/result?p=@stream-io/video-react-sdk) on Bundlephobia.

0 commit comments

Comments
 (0)