Skip to content

Commit

Permalink
docs: doc and images update
Browse files Browse the repository at this point in the history
  • Loading branch information
freeboub committed Aug 25, 2024
1 parent f910d54 commit 4b6880f
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 40 deletions.
10 changes: 8 additions & 2 deletions docs/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,18 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

![npm](https://img.shields.io/npm/v/react-native-peertube-iframe?style=for-the-badge) ![npm](https://img.shields.io/npm/dm/react-native-peertube-iframe?style=for-the-badge)

A wrapper of the **Peertube-iframe API** built for react native.
A wrapper of the Peertube IFrame player API build for react native.
This wrapper is based on [react-native-youtube-iframe](https://github.com/LonelyCpp/react-native-youtube-iframe)
You may still find some imported code or documentations inherited from this repository.

- ✅ Works seamlessly on both ios and android platforms
- ✅ Uses the webview player which is known to be more stable
- ✅ Uses the webview player which is known to be stable
- ✅ Supports multiple peertube player instances in a single page
- ✅ Works on modals and overlay components
- ✅ Expo support
- ❌ Playlist support
- ❌ Password support

<img alt="Docusaurus with Keytar" src={useBaseUrl('img/demo.gif')} />

A demo application can be found here : FIXME
3 changes: 0 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# React Native Peertube iframe

// FIXME
WARNING DO NOT USE THIS PROJECT FOR NOW.

![npm](https://img.shields.io/npm/v/react-native-peertube-iframe?style=for-the-badge) ![npm](https://img.shields.io/npm/dm/react-native-peertube-iframe?style=for-the-badge)

A wrapper of the Peertube IFrame player API build for react native.
Expand Down
1 change: 0 additions & 1 deletion src/PeertubeIframe.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import React, {
useRef,
useMemo,
useState,
useEffect,
forwardRef,
useCallback,
Expand Down
2 changes: 1 addition & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ module.exports = {
title: 'React Native Peertube-iframe',
logo: {
alt: 'React Native Peertube-iframe Logo',
src: 'img/logo.svg',
src: 'img/logo.png',
},
items: [
{
Expand Down
Binary file modified website/static/img/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/static/img/favicon.ico
Binary file not shown.
Binary file added website/static/img/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 0 additions & 33 deletions website/static/img/logo.svg

This file was deleted.

0 comments on commit 4b6880f

Please sign in to comment.