Skip to content

Commit be13291

Browse files
committed
docs: add GitHub Pages
1 parent 12440d2 commit be13291

2 files changed

Lines changed: 62 additions & 0 deletions

File tree

docs/_config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
title: React Native Frame Capture
2+
description: Reliable screen capture for React Native Android
3+
theme: jekyll-theme-cayman
4+
show_downloads: true
5+
github:
6+
repository_url: https://github.com/nasyx-rakeeb/react-native-frame-capture
7+
zip_url: https://github.com/nasyx-rakeeb/react-native-frame-capture/zipball/main
8+
tar_url: https://github.com/nasyx-rakeeb/react-native-frame-capture/tarball/main

docs/index.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# React Native Frame Capture
2+
3+
Reliable screen capture for React Native Android. Capture frames at intervals with customizable overlays and storage options.
4+
5+
## 📦 Installation
6+
7+
```bash
8+
npm install react-native-frame-capture
9+
```
10+
11+
## 📚 Documentation
12+
13+
- [API Reference](api-reference.md) - Complete API documentation
14+
- [Configuration](configuration.md) - Configuration options and interfaces
15+
- [Events](events.md) - Event types and handling
16+
- [Usage Examples](usage-examples.md) - Practical examples
17+
- [Storage](storage.md) - Storage behavior and options
18+
- [Permissions](permissions.md) - Permission requirements
19+
20+
## 🚀 Quick Start
21+
22+
```typescript
23+
import * as FrameCapture from 'react-native-frame-capture';
24+
25+
// Request permission
26+
const status = await FrameCapture.requestPermission();
27+
28+
if (status === FrameCapture.PermissionStatus.GRANTED) {
29+
// Start capturing
30+
await FrameCapture.startCapture({
31+
capture: { interval: 1000 },
32+
image: { quality: 80, format: 'jpeg' },
33+
});
34+
}
35+
```
36+
37+
## ✨ Features
38+
39+
- 📸 Interval-based capture (100ms - 60s)
40+
- 🎨 Customizable overlays
41+
- 💾 Flexible storage options
42+
- 🔄 Background capture
43+
- ⚡ High performance
44+
- 📱 Expo compatible
45+
46+
## 🔗 Links
47+
48+
- [GitHub Repository](https://github.com/nasyx-rakeeb/react-native-frame-capture)
49+
- [npm Package](https://www.npmjs.com/package/react-native-frame-capture)
50+
- [Example App](https://github.com/nasyx-rakeeb/react-native-frame-capture/tree/main/example)
51+
52+
## 📄 License
53+
54+
MIT © [Nasyx Rakeeb](https://github.com/nasyx-rakeeb)

0 commit comments

Comments
 (0)