piral-native/README.md

The Piral framework for use in React Native.

[![Piral Logo](https://github.com/smapiot/piral/raw/main/docs/assets/logo.png)](https://piral.io)

# [Piral Native](https://piral.io) · [![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/smapiot/piral/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/piral-native.svg?style=flat)](https://www.npmjs.com/package/piral-native) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://jestjs.io) [![Gitter Chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/piral-io/community)

This is the Piral framework prepared for use with React Native. Everything has to be prepared to run in a standard React Native application.

## Documentation

For details on the provided API check out the [documentation at the Piral website](https://docs.piral.io) or [on GitHub](https://github.com/smapiot/piral/tree/main/docs).

## Getting Started

Creating your own React Native app based on `piral-native` is as simple as installing `piral-native` as a dependency to your React Native app:

```sh
npm i piral-native
```

**Remark**: This package already includes TypeScript declarations. No need to install other packages.

## License

Piral is released using the MIT license. For more information see the [license file](./LICENSE).