From 59f32e0f9992e3663a937dd6ca9be1037c68c585 Mon Sep 17 00:00:00 2001 From: Fernando Otero Date: Wed, 27 Sep 2023 20:39:23 +0100 Subject: [PATCH] Update README.md --- README.md | 93 +++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 84 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7985d41d..0c24d024 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,95 @@ -# Metaplex Bubblegum +

+ Metaplex Bubblegum +

+

+ Create and manage compressed NFTs on Solana. Compressed NFTs make it possible to scale the creation of NFTs to new orders of magnitude by rethinking the way we store data on-chain. +

+

+ Metaplex Bubblegum +

+

+ + + + +

-Create and interact with compressed Metaplex NFTs +## Getting Started -## Programs +The packages below can be use to interact with Bubblegum program. -This project contains the following programs: +### TypeScript +```sh +npm install @metaplex-foundation/mpl-bubblegum +``` -- [Bubblegum](./programs/bubblegum/README.md) `BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY` +[See typedoc documentation](https://mpl-bubblegum-js-docs.vercel.app/). -You will need a Rust version compatible with BPF to compile the program, currently we recommend using Rust 1.68.0. +### Rust +```sh +cargo add mpl-bubblegum +``` -## Clients +[See crate documentation](https://docs.rs/mpl-bubblegum/latest/mpl_bubblegum/). -This project contains the following clients: +## Documentation -- [JavaScript](./clients/js/README.md) +Developer documentation for Bubblegum can be found [here](https://developers.metaplex.com/bubblegum). + +## Building + +From the root directory of the repository: + +- Install the required packges: +```sh +pnpm install +``` + +- Build the program: +```sh +pnpm programs:build +``` + +This will create the program binary at `/programs/.bin` + +## Testing + +Bubblegum includes two set of tests: BPF and TypeScript. + +### BPF + +From the root directory of the repository: +```sh +pnpm programs:test +``` + +### TypeScript + +From the root directory of the repository: +```sh +pnpm validator +``` + +This will start a local validator using [Amman](https://github.com/metaplex-foundation/amman). + +After starting the validator, go to the folder `/clients/js` and run: +```sh +pnpm install +``` + +This will install the required packages for the tests. Then, run: +```sh +pnpm build && pnpm test +``` +## Security + +To report a security issue, please follow the guidance on our [bug bounty program](https://www.metaplex.com/bounty-program) page. + +## License + +The Rust/Cargo programs are licensed under the +"Apache-style" [Metaplex(TM) NFT Open Source License](https://github.com/metaplex-foundation/mpl-token-metadata/blob/master/LICENSE) and the JS/TS client libraries are licensed +under either the [MIT](https://www.mit.edu/~amini/LICENSE.md) or the [Apache](https://www.apache.org/licenses/LICENSE-2.0.txt) licenses. ## Contributing