README.md
[![logo][]](https://xyo.network)
# clients
[![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 Protocol and its possible uses.
> We continue to maintain this software in the interest of developer education.
## Table of Contents
- [Title](#sdk-xyo-client-js)
- [Table of Contents](#table-of-contents)
- [Description](#description)
- [Install](#install)
- [Maintainers](#maintainers)
- [License](#license)
- [Credits](#credits)
## Description
> Primary SDK for using the XYO Protocol 2.0 from TypeScript/JavaScript.
> Designed to work in both browser based and Node JS based solutions.
## Use the sdk in another project
Using npm:
```sh
npm i --save @xyo-network/clients
```
Using yarn:
```sh
yarn add @xyo-network/clients
```
## 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/clients/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
[main-build]: https://github.com/XYOracleNetwork/clients/actions/workflows/build.yml/badge.svg
[main-build-link]: https://github.com/XYOracleNetwork/clients/actions/workflows/build.yml
[npm-badge]: https://img.shields.io/npm/v/@xyo-network/clients.svg
[npm-link]: https://www.npmjs.com/package/@xyo-network/clients
[codacy-badge]: https://app.codacy.com/project/badge/Grade/3aa7776c45aa42a3a8bba8be302fc363
[codacy-link]: https://www.codacy.com/gh/XYOracleNetwork/clients/dashboard?utm_source=github.com&utm_medium=referral&utm_content=XYOracleNetwork/clients&utm_campaign=Badge_Grade
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/8e85bbe6e7dc563efa7a/maintainability
[codeclimate-link]: https://codeclimate.com/github/XYOracleNetwork/clients/maintainability
[snyk-badge]: https://snyk.io/test/github/XYOracleNetwork/clients/badge.svg?targetFile=package.json
[snyk-link]: https://snyk.io/test/github/XYOracleNetwork/clients?targetFile=package.json
[license-badge]: https://img.shields.io/github/license/XYOracleNetwork/clients
[license-link]: https://github.com/XYOracleNetwork/clients/blob/main/LICENSE