railbird/react-native-vision-camera
10
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

docs: New README (#1744)

Browse Source 
* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Revert "Update README.md"

This reverts commit 8ce4949388323dc8d81366972b350476b77a8b99.

* Update README.md

* Update README.md

* Update README.md

* Revert "Update README.md"

This reverts commit 11c4655890d78728cff3ab31b8578f86ba6cbf0f.

* Delete settings.json

* Delete CODE_OF_CONDUCT.md

* Move `.clang-format` to `cpp/`

* Update README.md

* update docs

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update sidebars.js
This commit is contained in:
Marc Rousavy
2023-09-01 17:31:10 +02:00
committed by GitHub
parent 65aa9b49b7
commit 2a5c33323b
8 changed files with 40 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@@ -6,53 +6,41 @@
</picture>
</a>
<div align="center">
<img src="docs/static/img/11.png" width="50%">
<br />
<br />
<blockquote><b>📸 The Camera library that sees the vision.</b></blockquote>
<pre align="center">npm i <a href="https://www.npmjs.com/package/react-native-vision-camera">react-native-vision-camera</a><br/>npx pod-install </pre>
<a align="center" href='https://ko-fi.com/F1F8CLXG' target='_blank'>
<img height='36' style='border:0px;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi2.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' />
</a>
<br/>
<a align="center" href="https://github.com/mrousavy?tab=followers">
<img src="https://img.shields.io/github/followers/mrousavy?label=Follow%20%40mrousavy&style=social" />
</a>
<br />
<a align="center" href="https://twitter.com/mrousavy">
<img src="https://img.shields.io/twitter/follow/mrousavy?label=Follow%20%40mrousavy&style=social" />
</a>
</div>
<br/>
<br/>
<br />
<div>
<img align="right" width="35%" src="docs/static/img/example.png">
</div>
### ‼️‼️‼️‼️‼️ ✨ VisionCamera V3 ‼️‼️‼️‼️‼️
### Features
**See [this discussion](https://github.com/mrousavy/react-native-vision-camera/issues/1376) for the latest upcoming version of VisionCamera**
VisionCamera is a powerful and fast Camera component for React Native. It features:
* Photo and Video capture
* Customizable devices and multi-cameras ("fish-eye" zoom)
* Customizable resolutions and aspect-ratios (4k/8k images)
* Customizable FPS (30..240 FPS)
* [Frame Processors](https://react-native-vision-camera.com/docs/guides/frame-processors) (JS worklets to run QR-Code scanning, facial recognition, AI object detection, realtime video chats, ...)
* Smooth zooming (Reanimated)
* Fast pause and resume
* HDR & Night modes
* Custom C++/GPU accelerated video pipeline (OpenGL)
Install VisionCamera from npm:
```sh
yarn add react-native-vision-camera
cd ios && pod install
```
..and get started by [setting up permissions](https://react-native-vision-camera.com/docs/guides)!
### Documentation
* [Guides](https://react-native-vision-camera.com/docs/guides)
* [API](https://react-native-vision-camera.com/docs/api)
* [Example](./example/)
### Features
* Photo and Video capture
* Customizable devices and multi-cameras (smoothly zoom out to "fish-eye" camera)
* Customizable FPS
* [Frame Processors](https://react-native-vision-camera.com/docs/guides/frame-processors) (JS worklets to run QR-Code scanning, facial recognition, AI object detection, realtime video chats, ...)
* Smooth zooming (Reanimated)
* Fast pause and resume
* HDR & Night modes
> See the [example](./example/) app
* [Frame Processor Plugins](https://react-native-vision-camera.com/docs/guides/frame-processor-plugin-list)
### Example
@@ -72,6 +60,8 @@ function App() {
}
```
> See the [example](./example/) app
### Adopting at scale
<a href="https://github.com/sponsors/mrousavy">
@@ -82,6 +72,9 @@ VisionCamera is provided _as is_, I work on it in my free time.
If you're integrating VisionCamera in a production app, consider [funding this project](https://github.com/sponsors/mrousavy) and <a href="mailto:me@mrousavy.com?subject=Adopting VisionCamera at scale">contact me</a> to receive premium enterprise support, help with issues, prioritize bugfixes, request features, help at integrating VisionCamera and/or Frame Processors, and more.
<br />
### Socials
#### 🚀 Get started by [setting up permissions](https://react-native-vision-camera.com/docs/guides/)!
* 🐦 [**Follow me on Twitter**](https://twitter.com/mrousavy) for updates
* 📝 [**Check out my blog**](https://mrousavy.com/blog) for examples and experiments
* 💖 [**Sponsor me on GitHub**](https://github.com/sponsors/mrousavy) to support my work
* 🍪 [**Buy me a Ko-Fi**](https://ko-fi.com/mrousavy) to support my work