Skip to content

Commit

Permalink
docs: create introduction page
Browse files Browse the repository at this point in the history
  • Loading branch information
mihar-22 committed Aug 18, 2020
1 parent c8f23cd commit 9e04a25
Showing 1 changed file with 18 additions and 22 deletions.
40 changes: 18 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,25 @@
/>

Vime is simply a collection of [web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components)
that help you easily build and customize your own media player. See the [Features](#features) section
below for some more highlights on what Vime provides.
that enable you to easily build and customize your own media player.

🍭 They say a picture is worth a thousand words, so here's a few little bites of what you can
do with Vime ...
- 🖥  Responsive (mobile/desktop).
- 👌  Touch input friendly.
- 🎥  Multi-provider support (HTML5, HLS, YouTube, Vimeo etc.).
- ♾️  Avoid cross-browser differences on media related APIs such as fullscreen and picture-in-picture.
- 👐  [Accessible](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) via ARIA
roles/states/properties and keyboard support.
- 🌎  I18N support.
- 🎨  Style anything you want with [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties).
- 🏎️  Performant with [preconnections](https://css-tricks.com/using-relpreconnect-to-establish-network-connections-early-and-increase-performance) + [lazy loading](https://www.imperva.com/learn/performance/lazy-loading) of components and media out of the box.
- ️🧰  Awesome default UI's for audio/video/live media on mobile and desktop.
- 🛠  Comprehensive [player API](../components/core/player/readme.md).
- 💪  Built with TypeScript so you can enjoy completely typed components.
- 🏠  Feel right at home with HTML/CSS/JS thanks to web components.
- 🍽️  Serve it with your favourite framework whether it's React, Vue, Angular or whatever the cool
kids on the block use today.

🍭 Here's a few little bites of what you can do with Vime ...

```html
<!-- Here we are requesting to use the native controls. -->
Expand Down Expand Up @@ -77,24 +91,6 @@ do with Vime ...
</vime-player>
```

## Features

- 🖥 &nbsp;Responsive (mobile/desktop).
- 👌 &nbsp;Touch input friendly.
- 🎥 &nbsp;Multi-provider support (HTML5, HLS, YouTube, Vimeo etc.).
- ♾️ &nbsp;Avoid cross-browser differences on media related APIs such as fullscreen and picture-in-picture.
- 👐 &nbsp;[Accessible](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) via ARIA
roles/states/properties and keyboard support.
- 🌎 &nbsp;I18N support.
- 🎨 &nbsp;Style anything you want with [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties).
- 🏎️ &nbsp;Performant with [preconnections](https://css-tricks.com/using-relpreconnect-to-establish-network-connections-early-and-increase-performance) + [lazy loading](https://www.imperva.com/learn/performance/lazy-loading) of components and media out of the box.
- ️🧰 &nbsp;Awesome default UI's for audio/video/live media on mobile and desktop.
- 🛠 &nbsp;Comprehensive player API.
- 💪 &nbsp;Built with TypeScript so you can enjoy completely typed components.
- 🏠 &nbsp;Feel right at home with HTML/CSS/JS thanks to web components.
- 🍽️ &nbsp;Serve it with your favourite framework whether it's React, Vue, Angular or whatever the cool
kids on the block use today.

## 🏗️ Frameworks

There are framework specific bindings for:
Expand Down

0 comments on commit 9e04a25

Please sign in to comment.