Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated ReadMe #3424

Merged
merged 2 commits into from
Dec 17, 2024
Merged

updated ReadMe #3424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d473934
fix: corrected typo in ReadMe
ygit Dec 13, 2024
a03158a
fix: corrected typos in ReadMe
ygit Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ The 100ms SDK gives you everything you need to build scalable, high-quality live

**There are two ways you can add 100ms to your apps:**

1. ## Custom UI
## 1. Custom UI
- 100ms SDKs are powerful and highly extensible to build and support all custom experiences and UI.
- **Related packages include:** `@100mslive/react-sdk`, `@100mslive/hms-video-store` and `@100mslive/react-icons`.
- Get started with integrating the SDK using the [How to Guide](https://www.100ms.live/docs/javascript/v2/how-to-guides/install-the-sdk/integration).

> Navigate to `react-sdk` for the base React Hooks and some commonly used functionalities by clicking [here](./packages/react-sdk).

2. ## 100ms Prebuilt
## 2. 100ms Prebuilt
- 100ms Prebuilt is a high-level abstraction with no-code customization that enables you to embed video conferencing and/or live streaming UI—with a few lines of code.
- **Related packages include:** `roomkit-react` and `roomkit-web`.
- Get started with 100ms Prebuilt using the [Prebuilt Quickstart for Web](https://www.100ms.live/docs/javascript/v2/quickstart/prebuilt-quickstart).
Expand Down
9 changes: 5 additions & 4 deletions packages/react-icons/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,23 @@
[![License](https://img.shields.io/npm/l/@100mslive/react-icons)](https://www.100ms.live/)
![Tree shaking](https://badgen.net/bundlephobia/tree-shaking/@100mslive/react-icons)


Using the package in your application

```
```bash
// npm
npm install @100mslive/react-icons@latest --save

// yarn
yarn add @100mslive/react-icons@latest
```
### How to add icons

## How to add icons

1. add (only) 24x24 px svg file in `/assets`
2. Run

```bash
yarn build
yarn build
```

The jsx files for the corresponding files will be autogenerated.
Loading