Skip to content

Commit 5f18723

Browse files
committed
Add readme
1 parent d8976b4 commit 5f18723

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

Diff for: interface/README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<p align="center">
2+
<a href="https://solana.com">
3+
<img alt="Solana" src="https://github.com/user-attachments/assets/534af75d-6347-48dc-8943-129423b2ba63" height="80" />
4+
</a>
5+
</p>
6+
7+
# SPL Token Interface
8+
9+
This crate contains instructions and constructors for interacting with the [SPL Token program](https://spl.solana.com/token).
10+
11+
The Token program defines a common implementation for Fungible and Non Fungible tokens.
12+
13+
## Getting Started
14+
15+
From your project folder:
16+
17+
```bash
18+
cargo add spl-token-interface
19+
```
20+
21+
This will add the `spl-token-interface` dependency to your `Cargo.toml` file.
22+
23+
## Documentation
24+
25+
Read more about the Stake program on the crate [documentation](https://docs.rs/spl-token-interface/latest/spl_token_interface/).

Diff for: p-token/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
11
# `p-token`
22

33
A `pinocchio`-based Token program.
4+
5+
## Overview
6+
7+
`p-token` is a reimplementation of the SPL Token program, one of the most popular programs on Solana, using [`pinocchio`](https://github.com/anza-xyz/pinocchio). The purpose is to have an implementation that optimizes the compute units, while being fully compatible with the original implementation &mdash; i.e., support the exact same instruction and account layouts as SPL Token, byte for byte.
8+
9+
## Features
10+
11+
- `no_std` crate
12+
- Same instruction and account layout as SPL Token
13+
- Minimal CU usage
14+
15+
16+
## License
17+
18+
The code is licensed under the [Apache License Version 2.0](LICENSE)

0 commit comments

Comments
 (0)