Automatically build API documentation (#11)
* Automatically build API documentation using Typedoc and Docusaurus * Move MD and move to MDX for Docusaurus Guides
This commit is contained in:
31
README.md
31
README.md
@@ -1,27 +1,13 @@
|
||||
<table>
|
||||
<tr>
|
||||
<th>README</th>
|
||||
<th><a href="./docs/SETUP.md">SETUP</a></th>
|
||||
<th><a href="./docs/DEVICES.md">DEVICES</a></th>
|
||||
<th><a href="./docs/FORMATS.md">FORMATS</a></th>
|
||||
<th><a href="./docs/FRAME_PROCESSORS.md">FRAME_PROCESSORS</a></th>
|
||||
<th><a href="./docs/ANIMATED.md">ANIMATED</a></th>
|
||||
<th><a href="./docs/ERRORS.md">ERRORS</a></th>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
<h1 align="center">Camera</h1>
|
||||
<h1 align="center">Vision Camera</h1>
|
||||
|
||||
<div align="center">
|
||||
<img src="img/11.png" width="50%">
|
||||
<img src="docs/static/img/11.png" width="50%">
|
||||
<br />
|
||||
<br />
|
||||
<blockquote><h4>📸 The Camera library that sees the vision.</h4></blockquote>
|
||||
<br />
|
||||
|
||||
<a href="https://cuvent.com"><img height=40 src="./img/cuvent-logo-text.svg"></a>
|
||||
<a href="https://cuvent.com"><img height=40 src="docs/static/img/cuvent-logo-text.svg"></a>
|
||||
<br/>
|
||||
<span>
|
||||
<a align="center" href="https://github.com/mrousavy?tab=followers">
|
||||
@@ -44,9 +30,14 @@
|
||||
<br/>
|
||||
|
||||
<div>
|
||||
<img align="right" width="35%" src="./img/example.png">
|
||||
<img align="right" width="35%" src="docs/static/img/example.png">
|
||||
</div>
|
||||
|
||||
### Documentation
|
||||
|
||||
* [Guides (Getting Started) 🚀](https://cuvent.com)
|
||||
* [API 🧩](https://cuvent.com)
|
||||
|
||||
### Install
|
||||
|
||||
```sh
|
||||
@@ -54,8 +45,6 @@ npm i react-native-vision-camera
|
||||
npx pod-install
|
||||
```
|
||||
|
||||
> See [SETUP.md](./docs/SETUP.md)
|
||||
|
||||
### Features
|
||||
|
||||
* Photo and Video capture
|
||||
@@ -88,4 +77,4 @@ function App() {
|
||||
|
||||
<br />
|
||||
|
||||
#### 🚀 Get started by [setting up permissions](./docs/SETUP.md)!
|
||||
#### 🚀 Get started by [setting up permissions](https://cuvent.com)!
|
||||
|
||||
Reference in New Issue
Block a user