face-login v1.0.1

This package that allows you to integrate facial recognition login functionality into your React applications. It uses external APIs like Face++ for face detection and comparison to authenticate users.

Here's a sample README.md file for your face-login package:

# face-login

`face-login` is a React package that allows you to integrate facial recognition login functionality into your React applications. It uses external APIs like Face++ for face detection and comparison to authenticate users.

## Installation

You can install the package using npm:

```bash
npm install face-login

Usage

Importing the Package

First, import the functions you need from the face-login package:

import { faceLogin, detectFace } from 'face-login';

Example

Here’s an example of how to use face-login in a React component:

import React, { useState, useEffect } from 'react';
import { faceLogin, detectFace } from 'face-login';

const App: React.FC = () => {
  const [isLoggedIn, setIsLoggedIn] = useState(false);

  useEffect(() => {
    const performFaceLogin = async () => {
      try {
        const storedFaceToken = 'STORED_FACE_TOKEN';
        const newFaceToken = await detectFace('image_url_here', 'YOUR_API_KEY', 'YOUR_API_SECRET');
        
        const success = await faceLogin({
          apiKey: 'YOUR_API_KEY',
          apiSecret: 'YOUR_API_SECRET',
          faceToken1: storedFaceToken,
          faceToken2: newFaceToken
        });

        setIsLoggedIn(success);
      } catch (error) {
        console.error('Face login failed:', error);
      }
    };

    performFaceLogin();
  }, []);

  return (
    <div>
      {isLoggedIn ? <p>Welcome back!</p> : <p>Login failed.</p>}
    </div>
  );
};

export default App;

API

faceLogin(options: FaceLoginOptions): Promise<boolean>

• Description: Compares two face tokens to determine if they belong to the same person.
• Parameters:
  • options: An object containing the following properties:
    • apiKey: Your API key for the facial recognition service.
    • apiSecret: Your API secret for the facial recognition service.
    • faceToken1: The token of the stored face (e.g., the face of the registered user).
    • faceToken2: The token of the face to compare (e.g., the face of the person trying to log in).
• Returns: A promise that resolves to true if the faces match, or false otherwise.

detectFace(imageUrl: string, apiKey: string, apiSecret: string): Promise<string>

• Description: Detects a face in an image and returns the face token.
• Parameters:
  • imageUrl: The URL of the image containing the face to detect.
  • apiKey: Your API key for the facial recognition service.
  • apiSecret: Your API secret for the facial recognition service.
• Returns: A promise that resolves to the face token of the detected face.

License

This package is licensed under the MIT License.

### License

Ensure you have a `LICENSE` file in your repository if you mention a license in the `README.md`.

### Final Steps

- Place the `README.md` in the root directory of your package.
- Update the content to reflect any specific changes or additional features you may add.
- When you're ready, publish the package to npm.