Skip to content

Commit 9b967f2

Browse files
authored
More readme tweaks (#224)
* try something else * alt * wip * wip
1 parent b84a2be commit 9b967f2

File tree

3 files changed

+20
-9
lines changed

3 files changed

+20
-9
lines changed

.github/assets/livekit-mark.png

832 Bytes
Loading

.github/assets/livekit.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,30 @@
1-
<a href="https://livekit.io"><img src="./.github/assets/livekit.svg" width="132" height="30" alt="LiveKit logo" /></a>
1+
<a href="https://livekit.io/">
2+
<img src="./.github/assets/livekit-mark.png" alt="LiveKit logo" width="100" height="100">
3+
</a>
4+
5+
<h1>
6+
LiveKit Components
7+
</h1>
8+
9+
<p>
10+
<a href="#get-started"><strong>Get started</strong></a>
11+
12+
<a href="https://docs.livekit.io/">LiveKit Docs</a>
13+
14+
<a href="https://livekit.io/cloud">LiveKit Cloud</a>
15+
16+
<a href="https://blog.livekit.io/">Blog</a>
17+
</p>
218

319
<br>
420

5-
# LiveKit Components
6-
7-
Create your [LiveKit](https://livekit.io) WebRTC experience without worrying about state.
8-
9-
> **Disclaimer** This is project is in active development and open sourced as a developer preview. While APIs are unlikely to drastically change from here onwards, there's still the chance that some things might need tweaking after an update. We appreciate feedback from the community and are planning to incorporate your feedback to get to a stable version as soon as possible!
21+
> **Disclaimer —** This is project is in active development and open sourced as a developer preview. While APIs are unlikely to drastically change from here onwards, there's still the chance that some things might need tweaking after an update. We appreciate feedback from the community and are planning to incorporate your feedback to get to a stable version as soon as possible!
1022
1123
![LiveKit Components Preview](./.github/assets/components-preview-grid.png)
1224

1325
## About LiveKit Components
1426

15-
LiveKit Components give you a declarative way to build your real-time LiveKit audio/video frontend with React.
27+
Create your [LiveKit](https://livekit.io) WebRTC experience without worrying about state. LiveKit Components give you a declarative way to build your real-time LiveKit audio/video frontend with React.
1628

1729
Every use case is different and apps in the real world are individual and unique. We don't pretend to have the perfect solution that fits all use cases. Instead, we've taken an approach where we give you reasonable defaults, without taking away full control over each component if you want it.
1830

@@ -53,7 +65,7 @@ On top of that we provide a handful of pre-defined css variables to easily theme
5365

5466
The component we offer does not fit your requirements? We have the solution for you! Each component comes with its own React hook that allows you to create your own component with minimal boilerplate. Of course, you can also combine your own component with our pre-built components. It's common to start with our components to quickly sketch out a concept, and then replace some of them with your own components to build something we could never have imagined.
5567

56-
### Get started
68+
## Get started
5769

5870
The best way to get started is to use the [`@livekit/components-react`](/packages/react/) package and install it.
5971

0 commit comments

Comments
 (0)