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

52 lines
773 B
Markdown

# `@solana/spl-memo`
A TypeScript library for interacting with the SPL Memo program.
## Links
- [TypeScript Docs](https://solana-labs.github.io/solana-program-library/memo/js/)
- [Install](#install)
- [Build from Source](#build-from-source)
## Install
```shell
npm install --save @solana/spl-memo @solana/web3.js
```
_OR_
```shell
yarn add @solana/spl-memo @solana/web3.js
```
## Build from Source
0. Prerequisites
* Node 16+
* NPM 8+
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/memo/js
```
3. Install the dependencies:
```shell
npm install
```
4. Build the library:
```shell
npm run build
```
5. Run the tests:
```shell
npm run test
```