Skip to content

Commit

Permalink
docs(README): update README docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrol2b committed Oct 9, 2024
1 parent cb71b33 commit 4cf3666
Showing 1 changed file with 59 additions and 18 deletions.
77 changes: 59 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,70 @@

This plugin provides a simple way to use various ML Kit Vision APIs in your React Native App's [Frame processor](https://react-native-vision-camera.com/docs/guides/frame-processors).

> :warning: **This plugin is still in development and not yet ready for iOS.**
> ⚠️ **This plugin is still in development and not yet ready for iOS.**
## 🧵 Vision APIs
## 🧵 Vision APIs Roadmap

Video and image analysis APIs to label images and detect barcodes, text, faces, and objects.
This roadmap provides an overview of the progress for implementing various ML Kit Vision APIs. Note that all completed items are currently only available for Android. iOS support is still in development.

| # | APIs | Android | iOS |
| - | - | - | - |
| 1 | **[Barcode scanning](#barcode-scanning)** | [![done][done]][done] | [![in-progress][in-progress]][in-progress] |
| 2 | **[Face detection](#face-detection)** | [![not-started][not-started]][not-started] | [![not-started][not-started]][not-started] |
| 3 | **[Face mesh detection](#face-mesh-detection)** | [![not-started][not-started]][not-started] | [![not-supported][not-supported]][not-supported] |
| 4 | **[Text recognition v2](#text-recognition-v2)** | [![done][done]][done] | [![in-progress][in-progress]][in-progress] |
| 5 | **[Image labeling](#image-labeling)** | [![done][done]][done] | [![in-progress][in-progress]][in-progress] |
| 6 | **[Object detection and tracking](#object-detection-and-tracking)** | [![done][done]][done] | [![in-progress][in-progress]][in-progress] |
| 7 | **[Digital ink recognition](#digital-ink-recognition)** | [![not-started][not-started]][not-started] | [![not-started][not-started]][not-started] |
| 8 | **[Pose detection](#pose-detection)** | [![not-started][not-started]][not-started] | [![not-started][not-started]][not-started] |
| 9 | **[Selfie segmentation](#selfie-segmentation)** | [![not-started][not-started]][not-started] | [![not-started][not-started]][not-started] |
| 10 | **[Subject segmentation](#subject-segmentation)** | [![not-started][not-started]][not-started] | [![not-supported][not-supported]][not-supported] |
| 11 | **[Document scanner](#document-scanner)** | [![not-started][not-started]][not-started] | [![not-supported][not-supported]][not-supported] |

> 💬 Video and image analysis APIs to label images and detect barcodes, text, faces, and objects.
### **[Barcode scanning](https://developers.google.com/ml-kit/vision/barcode-scanning)**

- [X] **[Barcode scanning](https://developers.google.com/ml-kit/vision/barcode-scanning)**
Scan and process barcodes. Supports most standard 1D and 2D formats.
- [ ] **[Face detection](https://developers.google.com/ml-kit/vision/face-detection)**

### **[Face detection](https://developers.google.com/ml-kit/vision/face-detection)**

Detect faces and facial landmarks.
- [ ] **[Face mesh detection](https://developers.google.com/ml-kit/vision/face-mesh-detection)**

### **[Face mesh detection](https://developers.google.com/ml-kit/vision/face-mesh-detection)**

Detect face mesh info on close-range images.
- [X] **[Text recognition v2](https://developers.google.com/ml-kit/vision/text-recognition/v2)**

### **[Text recognition v2](https://developers.google.com/ml-kit/vision/text-recognition/v2)**

Recognize and extract text from images.
- [X] **[Image labeling](https://developers.google.com/ml-kit/vision/image-labeling)**

### **[Image labeling](https://developers.google.com/ml-kit/vision/image-labeling)**

Identify objects, locations, activities, animal species, products, and more. Use a general-purpose base model or tailor to your use case with a custom TensorFlow Lite model.
- [X] **[Object detection and tracking](https://developers.google.com/ml-kit/vision/object-detection)**

### **[Object detection and tracking](https://developers.google.com/ml-kit/vision/object-detection)**

Localize and track in real time one or more objects in the live camera feed.
- [ ] **[Digital ink recognition](https://developers.google.com/ml-kit/vision/digital-ink-recognition)**

### **[Digital ink recognition](https://developers.google.com/ml-kit/vision/digital-ink-recognition)**

Recognizes handwritten text and handdrawn shapes on a digital surface, such as a touch screen. Recognizes 300+ languages, emojis and basic shapes.
- [ ] **[Pose detection](https://developers.google.com/ml-kit/vision/pose-detection)**

### **[Pose detection](https://developers.google.com/ml-kit/vision/pose-detection)**

Detect the position of the human body in real time.
- [ ] **[Selfie segmentation](https://developers.google.com/ml-kit/vision/selfie-segmentation)**

### **[Selfie segmentation](https://developers.google.com/ml-kit/vision/selfie-segmentation)**

Separate the background from users within a scene and focus on what matters.
- [ ] **[Subject segmentation](https://developers.google.com/ml-kit/vision/subject-segmentation)**

### **[Subject segmentation](https://developers.google.com/ml-kit/vision/subject-segmentation)**

Separate subjects (people, pets, or objects) from the background in a picture.
- [ ] **[Document scanner](https://developers.google.com/ml-kit/vision/doc-scanner)**

### **[Document scanner](https://developers.google.com/ml-kit/vision/doc-scanner)**

Digitize physical documents from pictures.

## 🚀 Getting Started
Expand All @@ -49,10 +86,10 @@ Digitize physical documents from pictures.

Ensure you have installed the required packages before installing this plugin.

| Package | Version |
| - | - |
| [react-native-vision-camera](https://www.npmjs.com/package/react-native-vision-camera) | `>=4.0.1` |
| [react-native-worklets-core](https://www.npmjs.com/package/react-native-worklets-core) | `>=1.2.0` |
| # | Package | Version |
| - | - | - |
| 1 | [react-native-vision-camera](https://www.npmjs.com/package/react-native-vision-camera) | `>=4.0.1` |
| 2 | [react-native-worklets-core](https://www.npmjs.com/package/react-native-worklets-core) | `>=1.2.0` |

Follow the installation instructions for each package.

Expand Down Expand Up @@ -148,6 +185,10 @@ yarn add react-native-vision-camera-mlkit
);
```

[done]: https://img.shields.io/badge/done-4CAF50
[in-progress]: https://img.shields.io/badge/in%20progress-FF9800
[not-started]: https://img.shields.io/badge/not%20started-9E9E9E
[not-supported]: https://img.shields.io/badge/not%20supported-F44336
[contributors-shield]: https://img.shields.io/github/contributors/pedrol2b/react-native-vision-camera-mlkit.svg?style=for-the-badge
[contributors-url]: https://github.com/pedrol2b/react-native-vision-camera-mlkit/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/pedrol2b/react-native-vision-camera-mlkit.svg?style=for-the-badge
Expand Down

0 comments on commit 4cf3666

Please sign in to comment.