@alore/auth-react-native-sdk/README.md

React Native SDK for Alore Auth

<img src="https://storage.googleapis.com/alore_assets/auth-react-native-banner.png" alt="Alore Logo"/>

## Alore Native Auth - SDK

This is a bare React Native library that provides authentication features. It simplifies the integration of authentication methods in your React Native applications.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Installation

Run the following command:

```bash
yarn add @alore/auth-react-native-sdk
```

## Usage

To use the Alore Native Auth SDK in your project, follow these steps:

1. Get a free API Key at [https://alpha.bealore.com](https://alpha.bealore.com)

2. Import the library in your component:

   ```javascript
   import { AloreAuth } from '@alore/auth-react-native-sdk';
   ```

3. Use the `AloreAuth` class in your code:

   ```javascript
   const clientId = 'your-api-key';
   const endpoint = 'https://api.alore.com';

   const aloreAuth = new AloreAuth(clientId, { endpoint });
   ```

## Contributing

We welcome contributions! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/YourFeature`).
3. Make your changes and commit them (`git commit -m 'Add some feature'`).
4. Push to the branch (`git push origin feature/YourFeature`).
5. Open a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Contact

If you have any questions or suggestions, feel free to reach out to **[bealore.com](https://bealore.com/en/about-us)**.