@metaplex-foundation/mpl-candy-machine - npm Package Compare versions

Comparing version 6.0.0 to 6.0.1

package.json

		{
		"name": "@metaplex-foundation/mpl-candy-machine",
		"version": "6.0.0",
		"version": "6.0.1",
		"description": "Client library for Candy Machine related programs",
		@@ -19,3 +19,3 @@ "main": "dist/src/index.js",
		"peerDependencies": {
		"@metaplex-foundation/umi": "^0.8.2"
		"@metaplex-foundation/umi": ">= 0.8.2 < 1"
		},
		@@ -22,0 +22,0 @@ "dependencies": {

README.md

		@@ -1,9 +0,22 @@
		# Mpl Candy Machine
		# JavaScript client for Mpl Candy Machine

		Client library for Candy Machine related programs
		A Umi-compatible JavaScript library for candy machines.

		```shell
		npm install @metaplex-foundation/mpl-candy-machine@alpha
		```
		## Getting started

		[See typedoc documentation](https://mpl-candy-machine-js-docs.vercel.app/).
		1. First, if you're not already using Umi, [follow these instructions to install the Umi framework](https://github.com/metaplex-foundation/umi/blob/main/docs/installation.md).
		2. Next, install this library using the package manager of your choice.
		```sh
		npm install @metaplex-foundation/mpl-candy-machine
		```
		2. Finally, register the library with your Umi instance like so.
		```ts
		import { mplCandyMachine } from '@metaplex-foundation/mpl-candy-machine';
		umi.use(mplCandyMachine());
		```

		You can learn more about this library's API by reading its generated [TypeDoc documentation](https://mpl-candy-machine-js-docs.vercel.app).

		## Contributing

		Check out the [Contributing Guide](./CONTRIBUTING.md) the learn more about how to contribute to this library.

New alerts