XYOracleNetwork/sdk-xyo-react-js

[![logo][]][logo-link]

# @xyo-network/sdk-xyo-react

[![main-build][]][main-build-link]
[![npm-badge][]][npm-link]
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]
[![snyk-badge][]][snyk-link]
[![license-badge][]][license-link]

> The XYO Foundation provides this source code in our efforts to
> advance the understanding of the XYO Procotol and its possible uses.

## Table of Contents

-   [Description](#description)
-   [Install](#install)
-   [Maintainers](#maintainers)
-   [License](#license)
-   [Credits](#credits)

## Description

> Common React code that is used throughout XYO projects that use React.

## Use the sdk in another project

Using npm:

```sh
npm i --save @xyo-network/sdk-xyo-react
```

Using yarn:

```sh
yarn add @xyo-network/sdk-xyo-react
```

## Building the sdk locally

> First clone the repo to your local computer.  Once you have done that, from
> inside the folder where it was cloned, these are some commands you can do.

See list of XY scripts.

```sh
yarn xy help
```

Compile the mono repo

```sh
yarn xy compile
```

## Maintainers

-   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
-   [Matt Jones](https://github.com/jonesmac)
-   [Joel Carter](https://github.com/JoelBCarter)

## License

See the [LICENSE](https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-react-js/main/LICENSE)
file for license details

## Credits

[Made with 🔥 and ❄️ by XYO](https://xyo.network)

[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
[logo-link]: https://xyo.network

[main-build]: https://github.com/XYOracleNetwork/sdk-xyo-react-js/actions/workflows/build.yml/badge.svg
[main-build-link]: https://github.com/XYOracleNetwork/sdk-xyo-react-js/actions/workflows/build.yml

[npm-badge]: https://img.shields.io/npm/v/@xyo-network/sdk-xyo-react.svg
[npm-link]: https://www.npmjs.com/package/@xyo-network/sdk-xyo-react

[codacy-badge]: https://app.codacy.com/project/badge/Grade/0c82dd3b33c3494886a30b1c4ff5a8c0
[codacy-link]: https://www.codacy.com/gh/XYOracleNetwork/sdk-xyo-react-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=XYOracleNetwork/sdk-xyo-react-js&utm_campaign=Badge_Grade

[codeclimate-badge]: https://api.codeclimate.com/v1/badges/3d9b970fc814bbdd7d8f/maintainability
[codeclimate-link]: https://codeclimate.com/github/XYOracleNetwork/sdk-xyo-react-js/maintainability

[snyk-badge]: https://snyk.io/test/github/XYOracleNetwork/sdk-xyo-react-js/badge.svg?targetFile=package.json
[snyk-link]: https://snyk.io/test/github/XYOracleNetwork/sdk-xyo-react-js?targetFile=package.json

[license-badge]: https://img.shields.io/github/license/XYOracleNetwork/sdk-xyo-react-js
[license-link]: https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/main/LICENSE

[arietrouw-link]: https://github.com/XYOracleNetwork/sdk-xyo-react-js/blob/main/LICENSE