solana-program-library/token/js/README.md

50 lines
760 B
Markdown

# `@solana/spl-token`
A TypeScript library for interacting with the SPL Token program.
## Links
- [TypeScript Docs](https://solana-labs.github.io/solana-program-library/token/js/)
- [FAQ (Frequently Asked Questions)](./FAQ.md)
- [Install](#install)
- [Usage](#usage)
- [Build from Source](#build-from-source)
## Install
```shell
yarn add @solana/spl-token
```
## Build from Source
1. Clone the project:
```shell
git clone https://github.com/solana-labs/solana-program-library.git
```
2. Navigate to the library:
```shell
cd solana-program-library/token/js
```
3. Install the dependencies:
```shell
yarn install
```
4. Build the library:
```shell
yarn build
```
5. Run the tests:
```shell
yarn test
```
6. Run the example:
```shell
yarn example
```